blob: b2cbb339e2fa42edb39e85ebc6fac734fb731891 [file] [log] [blame]
Joe Gregorio2401bd62011-12-15 09:18:49 -05001
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-clear"><strong>clear</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears&nbsp;a&nbsp;primary&nbsp;calendar.&nbsp;This&nbsp;operation&nbsp;deletes&nbsp;all&nbsp;data&nbsp;associated&nbsp;with&nbsp;the&nbsp;primary&nbsp;calendar&nbsp;of&nbsp;an&nbsp;account&nbsp;and&nbsp;cannot&nbsp;be&nbsp;undone.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
21&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)</tt></dd></dl>
22
23<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes&nbsp;a&nbsp;secondary&nbsp;calendar.<br>
24&nbsp;<br>
25Args:<br>
26&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)</tt></dd></dl>
27
28<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;metadata&nbsp;for&nbsp;a&nbsp;calendar.<br>
29&nbsp;<br>
30Args:<br>
31&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)<br>
32&nbsp;<br>
33Returns:<br>
34&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
35&nbsp;<br>
36&nbsp;&nbsp;&nbsp;&nbsp;{<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
45
46<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates&nbsp;a&nbsp;secondary&nbsp;calendar.<br>
47&nbsp;<br>
48Args:<br>
49&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
50&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
51&nbsp;<br>
52{<br>
53&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
54&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
55&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
56&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
58&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
59&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
60&nbsp;&nbsp;}<br>
61&nbsp;<br>
62&nbsp;<br>
63Returns:<br>
64&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
65&nbsp;<br>
66&nbsp;&nbsp;&nbsp;&nbsp;{<br>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
74&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
75
76<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;metadata&nbsp;for&nbsp;a&nbsp;calendar.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
77&nbsp;<br>
78Args:<br>
79&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
80&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
81&nbsp;<br>
82{<br>
83&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
84&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
87&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
90&nbsp;&nbsp;}<br>
91&nbsp;<br>
92&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)<br>
93&nbsp;<br>
94Returns:<br>
95&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
96&nbsp;<br>
97&nbsp;&nbsp;&nbsp;&nbsp;{<br>
98&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
99&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
100&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
105&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
106
107<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;metadata&nbsp;for&nbsp;a&nbsp;calendar.<br>
108&nbsp;<br>
109Args:<br>
110&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
111&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
112&nbsp;<br>
113{<br>
114&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
115&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
116&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
117&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
118&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
119&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
120&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
121&nbsp;&nbsp;}<br>
122&nbsp;<br>
123&nbsp;&nbsp;calendarId:&nbsp;string,&nbsp;Calendar&nbsp;identifier.&nbsp;(required)<br>
124&nbsp;<br>
125Returns:<br>
126&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
127&nbsp;<br>
128&nbsp;&nbsp;&nbsp;&nbsp;{<br>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#calendar",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#calendar").<br>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"summary":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;calendar.<br>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Geographic&nbsp;location&nbsp;of&nbsp;the&nbsp;calendar&nbsp;as&nbsp;free-form&nbsp;text.&nbsp;Optional.<br>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeZone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;zone&nbsp;of&nbsp;the&nbsp;calendar.&nbsp;Optional.<br>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Identifier&nbsp;of&nbsp;the&nbsp;calendar.<br>
136&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
137
138<hr>
139Data descriptors defined here:<br>
140<dl><dt><strong>__dict__</strong></dt>
141<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
142</dl>
143<dl><dt><strong>__weakref__</strong></dt>
144<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
145</dl>
146</td></tr></table>
147</body></html>