| Joe Gregorio | 4189954 | 2012-04-23 09:02:05 -0400 | [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-annotationData"><strong><a href="books.v1.layers.annotationData.html">annotationData</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| 18 | |
| 19 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the layer summary for a volume.<br> |
| 20 | <br> |
| 21 | Args:<br> |
| 22 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| 23 | source: string, String to identify the originator of this request.<br> |
| 24 | summaryId: string, The ID for the layer to get the summary for. (required)<br> |
| 25 | <br> |
| 26 | Returns:<br> |
| 27 | An object of the form<br> |
| 28 | <br> |
| 29 | {<br> |
| 30 | "kind": "books#layersummary", # Resource Type<br> |
| 31 | "annotationCount": 42, # The number of annotations for this layer.<br> |
| 32 | "dataCount": 42, # The number of data items for this layer.<br> |
| 33 | "annotationsLink": "A String", # The link to get the annotations for this layer.<br> |
| 34 | "updated": "A String", # Timestamp for the last time an item in this layer was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br> |
| 35 | "annotationsDataLink": "A String", # Link to get data for this annotation.<br> |
| 36 | "annotationTypes": [ # The list of annotation types contained for this layer. *<br> |
| 37 | "A String",<br> |
| 38 | ],<br> |
| 39 | "layerId": "A String", # The layer id for this summary.<br> |
| 40 | "id": "A String", # Unique id of this layer summary.<br> |
| 41 | "selfLink": "A String", # URL to this resource.<br> |
| 42 | }</tt></dd></dl> |
| 43 | |
| 44 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List the layer summaries for a volume.<br> |
| 45 | <br> |
| 46 | Args:<br> |
| 47 | source: string, String to identify the originator of this request.<br> |
| 48 | country: string, ISO-3166-1 code to override the IP-based location.<br> |
| 49 | volumeId: string, The volume to retrieve layers for. (required)<br> |
| 50 | maxResults: integer, Maximum number of results to return<br> |
| 51 | pageToken: string, The value of the nextToken from the previous page.<br> |
| 52 | contentVersion: string, The content version for the requested volume.<br> |
| 53 | <br> |
| 54 | Returns:<br> |
| 55 | An object of the form<br> |
| 56 | <br> |
| 57 | {<br> |
| 58 | "totalItems": 42, # The total number of layer summaries found.<br> |
| 59 | "items": [ # A list of layer summary items.<br> |
| 60 | {<br> |
| 61 | "kind": "books#layersummary", # Resource Type<br> |
| 62 | "annotationCount": 42, # The number of annotations for this layer.<br> |
| 63 | "dataCount": 42, # The number of data items for this layer.<br> |
| 64 | "annotationsLink": "A String", # The link to get the annotations for this layer.<br> |
| 65 | "updated": "A String", # Timestamp for the last time an item in this layer was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br> |
| 66 | "annotationsDataLink": "A String", # Link to get data for this annotation.<br> |
| 67 | "annotationTypes": [ # The list of annotation types contained for this layer. *<br> |
| 68 | "A String",<br> |
| 69 | ],<br> |
| 70 | "layerId": "A String", # The layer id for this summary.<br> |
| 71 | "id": "A String", # Unique id of this layer summary.<br> |
| 72 | "selfLink": "A String", # URL to this resource.<br> |
| 73 | },<br> |
| 74 | ],<br> |
| 75 | "kind": "books#layersummaries", # Resource type.<br> |
| 76 | }</tt></dd></dl> |
| 77 | |
| 78 | <hr> |
| 79 | Data descriptors defined here:<br> |
| 80 | <dl><dt><strong>__dict__</strong></dt> |
| 81 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 82 | </dl> |
| 83 | <dl><dt><strong>__weakref__</strong></dt> |
| 84 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 85 | </dl> |
| 86 | </td></tr></table> |
| 87 | </body></html> |