blob: 33acb763933ac7faed921ed6f327182d5dc70bf0 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class Resource</title>
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<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>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete&nbsp;a&nbsp;group<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;group&nbsp;to&nbsp;delete.&nbsp;(required)</tt></dd></dl>
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;group<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;group&nbsp;to&nbsp;get.&nbsp;(required)</tt></dd></dl>
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Create&nbsp;a&nbsp;group<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;user's&nbsp;groups<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes&nbsp;a&nbsp;single&nbsp;argument,&nbsp;'body',&nbsp;which&nbsp;is&nbsp;the&nbsp;results<br>
from&nbsp;the&nbsp;last&nbsp;call,&nbsp;and&nbsp;returns&nbsp;the&nbsp;next&nbsp;set&nbsp;of&nbsp;items<br>
in&nbsp;the&nbsp;collection.<br>
&nbsp;<br>
Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in<br>
the&nbsp;collection.</tt></dd></dl>
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Update&nbsp;a&nbsp;group.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;group&nbsp;to&nbsp;update.&nbsp;(required)</tt></dd></dl>
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update&nbsp;a&nbsp;group<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;group&nbsp;to&nbsp;update.&nbsp;(required)</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>