blob: 4b1916a57c9b05f07c89cd5d8f521a73529b790a [file] [log] [blame]
Joe Gregorio02503852011-08-31 09:07:55 -04001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;activities&nbsp;for&nbsp;a&nbsp;specific&nbsp;customer&nbsp;and&nbsp;application.<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio02503852011-08-31 09:07:55 -040020&nbsp;&nbsp;caller:&nbsp;string,&nbsp;Type&nbsp;of&nbsp;the&nbsp;caller.<br>
21&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
22&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;application_owner&nbsp;-&nbsp;Caller&nbsp;is&nbsp;an&nbsp;application&nbsp;owner.<br>
23&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;customer&nbsp;-&nbsp;Caller&nbsp;is&nbsp;a&nbsp;customer.<br>
Joe Gregorio02503852011-08-31 09:07:55 -040024&nbsp;&nbsp;actorApplicationId:&nbsp;string,&nbsp;Application&nbsp;ID&nbsp;of&nbsp;the&nbsp;application&nbsp;which&nbsp;interacted&nbsp;on&nbsp;behalf&nbsp;of&nbsp;the&nbsp;user&nbsp;while&nbsp;performing&nbsp;the&nbsp;event.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -040025&nbsp;&nbsp;actorIpAddress:&nbsp;string,&nbsp;IP&nbsp;Address&nbsp;of&nbsp;host&nbsp;where&nbsp;the&nbsp;event&nbsp;was&nbsp;performed.&nbsp;Supports&nbsp;both&nbsp;IPv4&nbsp;and&nbsp;IPv6&nbsp;addresses.<br>
26&nbsp;&nbsp;actorEmail:&nbsp;string,&nbsp;Email&nbsp;address&nbsp;of&nbsp;the&nbsp;user&nbsp;who&nbsp;performed&nbsp;the&nbsp;action.<br>
27&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Number&nbsp;of&nbsp;activity&nbsp;records&nbsp;to&nbsp;be&nbsp;shown&nbsp;in&nbsp;each&nbsp;page.<br>
Joe Gregorio02503852011-08-31 09:07:55 -040028&nbsp;&nbsp;continuationToken:&nbsp;string,&nbsp;Next&nbsp;page&nbsp;URL.<br>
Joe Gregorioa8451672011-09-15 09:53:21 -040029&nbsp;&nbsp;eventName:&nbsp;string,&nbsp;Name&nbsp;of&nbsp;the&nbsp;event&nbsp;being&nbsp;queried.<br>
30&nbsp;&nbsp;endTime:&nbsp;string,&nbsp;Return&nbsp;events&nbsp;which&nbsp;occured&nbsp;at&nbsp;or&nbsp;before&nbsp;this&nbsp;time.<br>
31&nbsp;&nbsp;startTime:&nbsp;string,&nbsp;Return&nbsp;events&nbsp;which&nbsp;occured&nbsp;at&nbsp;or&nbsp;after&nbsp;this&nbsp;time.<br>
32&nbsp;&nbsp;parameters:&nbsp;string,&nbsp;Event&nbsp;parameters&nbsp;in&nbsp;the&nbsp;form&nbsp;[parameter1&nbsp;name]:[parameter1&nbsp;value],[parameter2&nbsp;name]:[parameter2&nbsp;value],...<br>
33&nbsp;&nbsp;applicationId:&nbsp;string,&nbsp;Application&nbsp;ID&nbsp;of&nbsp;the&nbsp;application&nbsp;on&nbsp;which&nbsp;the&nbsp;event&nbsp;was&nbsp;performed.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050034&nbsp;&nbsp;customerId:&nbsp;string,&nbsp;Represents&nbsp;the&nbsp;customer&nbsp;who&nbsp;is&nbsp;the&nbsp;owner&nbsp;of&nbsp;target&nbsp;object&nbsp;on&nbsp;which&nbsp;action&nbsp;was&nbsp;performed.&nbsp;(required)<br>
35&nbsp;<br>
36Returns:<br>
37&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
38&nbsp;<br>
39&nbsp;&nbsp;&nbsp;&nbsp;{<br>
40&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;Each&nbsp;record&nbsp;in&nbsp;read&nbsp;response.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"audit#activity",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ownerDomain":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Domain&nbsp;of&nbsp;source&nbsp;customer.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"actor":&nbsp;{&nbsp;#&nbsp;User&nbsp;doing&nbsp;the&nbsp;action.<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"applicationId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ID&nbsp;of&nbsp;application&nbsp;which&nbsp;interacted&nbsp;on&nbsp;behalf&nbsp;of&nbsp;the&nbsp;user.<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"email":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Email&nbsp;address&nbsp;of&nbsp;the&nbsp;user.<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"key":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;For&nbsp;OAuth&nbsp;2LO&nbsp;API&nbsp;requests,&nbsp;consumer_key&nbsp;of&nbsp;the&nbsp;requestor.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"callerType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;User&nbsp;or&nbsp;OAuth&nbsp;2LO&nbsp;request.<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;{&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;for&nbsp;each&nbsp;activity&nbsp;record.<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uniqQualifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;qualifier&nbsp;if&nbsp;multiple&nbsp;events&nbsp;have&nbsp;the&nbsp;same&nbsp;time.<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"applicationId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Application&nbsp;ID&nbsp;of&nbsp;the&nbsp;source&nbsp;application.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"customerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Obfuscated&nbsp;customer&nbsp;ID&nbsp;of&nbsp;the&nbsp;source&nbsp;customer.<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"time":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;of&nbsp;occurrence&nbsp;of&nbsp;the&nbsp;activity.<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ipAddress":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;IP&nbsp;Address&nbsp;of&nbsp;the&nbsp;user&nbsp;doing&nbsp;the&nbsp;action.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"events":&nbsp;[&nbsp;#&nbsp;Activity&nbsp;events.<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"eventType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;event.<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;event.<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parameters":&nbsp;[&nbsp;#&nbsp;Event&nbsp;parameters.<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;parameter.<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"value":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Value&nbsp;of&nbsp;the&nbsp;parameter.<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
66&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
70&nbsp;&nbsp;&nbsp;&nbsp;],<br>
71&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"audit#activities",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;list&nbsp;response&nbsp;this&nbsp;is.<br>
72&nbsp;&nbsp;&nbsp;&nbsp;"next":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Next&nbsp;page&nbsp;URL.<br>
73&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio02503852011-08-31 09:07:55 -040074
75<hr>
76Data descriptors defined here:<br>
77<dl><dt><strong>__dict__</strong></dt>
78<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
79</dl>
80<dl><dt><strong>__weakref__</strong></dt>
81<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
82</dl>
83</td></tr></table>
84</body></html>