| |
| <!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> <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> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </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-annotationData"><strong><a href="books.v1.layers.annotationData.html">annotationData</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the layer summary for a volume.<br> |
| <br> |
| Args:<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| source: string, String to identify the originator of this request.<br> |
| volumeId: string, The volume to retrieve layers for. (required)<br> |
| strict: string, A parameter<br> |
| contentVersion: string, The content version for the requested volume.<br> |
| userip: string, A parameter<br> |
| summaryId: string, The ID for the layer to get the summary for. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "books#layersummary", # Resource Type<br> |
| "annotationCount": 42, # The number of annotations for this layer.<br> |
| "dataCount": 42, # The number of data items for this layer.<br> |
| "annotationsLink": "A String", # The link to get the annotations for this layer.<br> |
| "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> |
| "volumeId": "A String", # The volume id this resource is for.<br> |
| "id": "A String", # Unique id of this layer summary.<br> |
| "annotationTypes": [ # The list of annotation types contained for this layer.<br> |
| "A String",<br> |
| ],<br> |
| "contentVersion": "A String", # The content version this resource is for.<br> |
| "layerId": "A String", # The layer id for this summary.<br> |
| "annotationsDataLink": "A String", # Link to get data for this annotation.<br> |
| "selfLink": "A String", # URL to this resource.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List the layer summaries for a volume.<br> |
| <br> |
| Args:<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| pageToken: string, The value of the nextToken from the previous page.<br> |
| volumeId: string, The volume to retrieve layers for. (required)<br> |
| maxResults: integer, Maximum number of results to return<br> |
| source: string, String to identify the originator of this request.<br> |
| contentVersion: string, The content version for the requested volume.<br> |
| userip: string, A parameter<br> |
| strict: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "totalItems": 42, # The total number of layer summaries found.<br> |
| "items": [ # A list of layer summary items.<br> |
| {<br> |
| "kind": "books#layersummary", # Resource Type<br> |
| "annotationCount": 42, # The number of annotations for this layer.<br> |
| "dataCount": 42, # The number of data items for this layer.<br> |
| "annotationsLink": "A String", # The link to get the annotations for this layer.<br> |
| "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> |
| "volumeId": "A String", # The volume id this resource is for.<br> |
| "id": "A String", # Unique id of this layer summary.<br> |
| "annotationTypes": [ # The list of annotation types contained for this layer.<br> |
| "A String",<br> |
| ],<br> |
| "contentVersion": "A String", # The content version this resource is for.<br> |
| "layerId": "A String", # The layer id for this summary.<br> |
| "annotationsDataLink": "A String", # Link to get data for this annotation.<br> |
| "selfLink": "A String", # URL to this resource.<br> |
| },<br> |
| ],<br> |
| "kind": "books#layersummaries", # Resource type.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-volumeAnnotations"><strong><a href="books.v1.layers.volumeAnnotations.html">volumeAnnotations</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |