Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 1 | |
| 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> <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> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete a group<br> |
| 18 | <br> |
| 19 | Args:<br> |
Joe Gregorio | 20a5aa9 | 2011-04-01 17:44:25 -0400 | [diff] [blame^] | 20 | userId: string, ID of the user being referenced. (required)<br> |
| 21 | hl: string, Language code to limit language results.<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 22 | alt: string, Specifies an alternative representation type.<br> |
| 23 | Allowed values<br> |
| 24 | atom - Use Atom XML format<br> |
| 25 | json - Use JSON format<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 26 | groupId: string, ID of the group to delete. (required)</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 27 | |
| 28 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a group<br> |
| 29 | <br> |
| 30 | Args:<br> |
Joe Gregorio | 20a5aa9 | 2011-04-01 17:44:25 -0400 | [diff] [blame^] | 31 | userId: string, ID of the user being referenced. (required)<br> |
| 32 | hl: string, Language code to limit language results.<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 33 | alt: string, Specifies an alternative representation type.<br> |
| 34 | Allowed values<br> |
| 35 | atom - Use Atom XML format<br> |
| 36 | json - Use JSON format<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 37 | groupId: string, ID of the group to get. (required)</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 38 | |
| 39 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Create a group<br> |
| 40 | <br> |
| 41 | Args:<br> |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 42 | body: object, The request body. (required)<br> |
Joe Gregorio | 20a5aa9 | 2011-04-01 17:44:25 -0400 | [diff] [blame^] | 43 | userId: string, ID of the user being referenced. (required)<br> |
| 44 | hl: string, Language code to limit language results.<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 45 | alt: string, Specifies an alternative representation type.<br> |
| 46 | Allowed values<br> |
| 47 | atom - Use Atom XML format<br> |
Joe Gregorio | 20a5aa9 | 2011-04-01 17:44:25 -0400 | [diff] [blame^] | 48 | json - Use JSON format</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 49 | |
| 50 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a user's groups<br> |
| 51 | <br> |
| 52 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 53 | c: string, A continuation token that allows pagination.<br> |
| 54 | userId: string, ID of the user being referenced. (required)<br> |
| 55 | max_results: integer, Maximum number of results to include.<br> |
| 56 | hl: string, Language code to limit language results.<br> |
| 57 | alt: string, Specifies an alternative representation type.<br> |
| 58 | Allowed values<br> |
| 59 | atom - Use Atom XML format<br> |
| 60 | json - Use JSON format</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 61 | |
| 62 | <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes a single argument, 'body', which is the results<br> |
| 63 | from the last call, and returns the next set of items<br> |
| 64 | in the collection.<br> |
| 65 | <br> |
| 66 | Returns None if there are no more items in<br> |
| 67 | the collection.</tt></dd></dl> |
| 68 | |
| 69 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a group<br> |
| 70 | <br> |
| 71 | Args:<br> |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 72 | body: object, The request body. (required)<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 73 | userId: string, ID of the user being referenced. (required)<br> |
| 74 | hl: string, Language code to limit language results.<br> |
| 75 | alt: string, Specifies an alternative representation type.<br> |
| 76 | Allowed values<br> |
| 77 | atom - Use Atom XML format<br> |
| 78 | json - Use JSON format<br> |
| 79 | groupId: string, ID of the group to update. (required)</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 80 | |
| 81 | <hr> |
| 82 | Data descriptors defined here:<br> |
| 83 | <dl><dt><strong>__dict__</strong></dt> |
| 84 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 85 | </dl> |
| 86 | <dl><dt><strong>__weakref__</strong></dt> |
| 87 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 88 | </dl> |
| 89 | </td></tr></table> |
| 90 | </body></html> |