| |
| <!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-getRest"><strong>getRest</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieve the description of a particular version of an api.<br> |
| <br> |
| Args:<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| api: string, The name of the API. (required)<br> |
| strict: string, A parameter<br> |
| version: string, The version of the API. (required)<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "protocol": "rest", # The protocol described by this document.<br> |
| "methods": { # API-level methods for this API.<br> |
| },<br> |
| "labels": [ # Labels for the status of this API, such as labs or deprecated.<br> |
| "A String",<br> |
| ],<br> |
| "batchPath": "batch", # The path for REST batch requests.<br> |
| "id": "A String", # The id of this API.<br> |
| "schemas": { # The schemas for this API.<br> |
| },<br> |
| "rootUrl": "A String", # The root url under which all API services live.<br> |
| "parameters": { # Common parameters that apply across all apis.<br> |
| },<br> |
| "icons": { # Links to 16x16 and 32x32 icons representing the API.<br> |
| "x32": "A String", # The url of the 32x32 icon.<br> |
| "x16": "A String", # The url of the 16x16 icon.<br> |
| },<br> |
| "baseUrl": "A String", # [DEPRECATED] The base URL for REST requests.<br> |
| "version": "A String", # The version of this API.<br> |
| "features": [ # A list of supported features for this API.<br> |
| "A String",<br> |
| ],<br> |
| "servicePath": "A String", # The base path for all REST requests.<br> |
| "resources": { # The resources in this API.<br> |
| },<br> |
| "revision": "A String", # The version of this API.<br> |
| "description": "A String", # The description of this API.<br> |
| "auth": { # Authentication information.<br> |
| "oauth2": { # OAuth 2.0 authentication information.<br> |
| "scopes": { # Available OAuth 2.0 scopes.<br> |
| },<br> |
| },<br> |
| },<br> |
| "kind": "discovery#restDescription", # The kind for this response.<br> |
| "name": "A String", # The name of this API.<br> |
| "basePath": "A String", # [DEPRECATED] The base path for REST requests.<br> |
| "title": "A String", # The title of this API.<br> |
| "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.<br> |
| "documentationLink": "A String", # A link to human readable documentation for the API.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieve the list of APIs supported at this endpoint.<br> |
| <br> |
| Args:<br> |
| pp: string, A parameter<br> |
| name: string, Only include APIs with the given name.<br> |
| trace: string, A parameter<br> |
| preferred: boolean, Return only the preferred version of an API.<br> |
| label: string, Only include APIs with a matching label, such as 'graduated' or 'labs'.<br> |
| Allowed values<br> |
| deprecated - APIs that have been deprecated.<br> |
| graduated - Supported APIs that have graduated from labs.<br> |
| labs - APIs that are experimental<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "items": [ # The individual directory entries. One entry per api/version pair.<br> |
| {<br> |
| "kind": "discovery#directoryItem", # The kind for this response.<br> |
| "labels": [ # Labels for the status of this API, such as labs or deprecated.<br> |
| "A String",<br> |
| ],<br> |
| "description": "A String", # The description of this API.<br> |
| "icons": { # Links to 16x16 and 32x32 icons representing the API.<br> |
| "x32": "A String", # The url of the 32x32 icon.<br> |
| "x16": "A String", # The url of the 16x16 icon.<br> |
| },<br> |
| "discoveryRestUrl": "A String", # The url for the discovery REST document.<br> |
| "preferred": True or False, # True if this version is the preferred version to use.<br> |
| "name": "A String", # The name of the API.<br> |
| "discoveryLink": "A String", # A link to the discovery document.<br> |
| "version": "A String", # The version of the API.<br> |
| "title": "A String", # The title of this API.<br> |
| "id": "A String", # The id of this API.<br> |
| "documentationLink": "A String", # A link to human readable documentation for the API.<br> |
| },<br> |
| ],<br> |
| "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc.<br> |
| "kind": "discovery#directoryList", # The kind for this response.<br> |
| }</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> |