| <?xml version="1.0" encoding="ascii"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <title>apiclient.discovery</title> |
| <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
| <script type="text/javascript" src="epydoc.js"></script> |
| </head> |
| |
| <body bgcolor="white" text="black" link="blue" vlink="#204080" |
| alink="#204080"> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <th class="navbar" width="100%"></th> |
| </tr> |
| </table> |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr valign="top"> |
| <td width="100%"> |
| <span class="breadcrumbs"> |
| <a href="apiclient-module.html">Package apiclient</a> :: |
| Module discovery |
| </span> |
| </td> |
| <td> |
| <table cellpadding="0" cellspacing="0"> |
| <!-- hide/show private --> |
| <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
| onclick="toggle_private();">hide private</a>]</span></td></tr> |
| <tr><td align="right"><span class="options" |
| >[<a href="frames.html" target="_top">frames</a |
| >] | <a href="apiclient.discovery-module.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== MODULE DESCRIPTION ==================== --> |
| <h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.discovery-pysrc.html">source code</a></span></p> |
| <pre class="literalblock"> |
| Client for discovery based APIs |
| |
| A client library for Google's discovery based APIs. |
| |
| </pre> |
| |
| <hr /> |
| <div class="fields"> <p><strong>Author:</strong> |
| jcgregorio@google.com (Joe Gregorio) |
| </p> |
| </div><!-- ==================== FUNCTIONS ==================== --> |
| <a name="section-Functions"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td colspan="2" class="table-header"> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| <tr valign="top"> |
| <td align="left"><span class="table-header">Functions</span></td> |
| <td align="right" valign="top" |
| ><span class="options">[<a href="#section-Functions" |
| class="privatelink" onclick="toggle_private();" |
| >hide private</a>]</span></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="apiclient.discovery-module.html#fix_method_name" class="summary-sig-name" onclick="show_private();">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br /> |
| Fix method names to avoid reserved word conflicts.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_add_query_parameter" class="summary-sig-name" onclick="show_private();">_add_query_parameter</a>(<span class="summary-sig-arg">url</span>, |
| <span class="summary-sig-arg">name</span>, |
| <span class="summary-sig-arg">value</span>)</span><br /> |
| Adds a query parameter to a url.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="apiclient.discovery-module.html#key2param" class="summary-sig-name">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br /> |
| Converts key names into parameter names.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">serviceName</span>, |
| <span class="summary-sig-arg">version</span>, |
| <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersio</code><code class="variable-ellipsis">...</code></span>, |
| <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default"><class 'apiclient.http.HttpRequest'></span>)</span><br /> |
| Construct a Resource for interacting with an API.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build_from_document" class="summary-sig-name" onclick="show_private();">build_from_document</a>(<span class="summary-sig-arg">service</span>, |
| <span class="summary-sig-arg">base</span>, |
| <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>, |
| <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default"><class 'apiclient.http.HttpRequest'></span>)</span><br /> |
| Create a Resource for interacting with an API.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_cast" class="summary-sig-name" onclick="show_private();">_cast</a>(<span class="summary-sig-arg">value</span>, |
| <span class="summary-sig-arg">schema_type</span>)</span><br /> |
| Convert value to a string based on JSON Schema type.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_media_size_to_long" class="summary-sig-name" onclick="show_private();">_media_size_to_long</a>(<span class="summary-sig-arg">maxSize</span>)</span><br /> |
| Convert a string media size, such as 10GB or 3TB into an integer.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_createResource" class="summary-sig-name" onclick="show_private();">_createResource</a>(<span class="summary-sig-arg">http</span>, |
| <span class="summary-sig-arg">baseUrl</span>, |
| <span class="summary-sig-arg">model</span>, |
| <span class="summary-sig-arg">requestBuilder</span>, |
| <span class="summary-sig-arg">developerKey</span>, |
| <span class="summary-sig-arg">resourceDesc</span>, |
| <span class="summary-sig-arg">rootDesc</span>, |
| <span class="summary-sig-arg">schema</span>)</span><br /> |
| Build a Resource from the API description.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="apiclient.discovery-pysrc.html#_createResource">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== VARIABLES ==================== --> |
| <a name="section-Variables"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td colspan="2" class="table-header"> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| <tr valign="top"> |
| <td align="left"><span class="table-header">Variables</span></td> |
| <td align="right" valign="top" |
| ><span class="options">[<a href="#section-Variables" |
| class="privatelink" onclick="toggle_private();" |
| >hide private</a>]</span></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile(r'\{[^\}]*\}')">re.compile(r'\{<code class="re-group">[^</code>\}<code class="re-group">]</code><code class="re-op">*</code>\}')</code> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="VARNAME"></a><span class="summary-name">VARNAME</span> = <code title="re.compile(r'[a-zA-Z0-9_-]+')">re.compile(r'<code class="re-group">[</code>a<code class="re-op">-</code>zA<code class="re-op">-</code>Z0<code class="re-op">-</code>9_-<code class="re-group">]</code><code class="re-op">+</code>')</code> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="apiclient.discovery-module.html#DISCOVERY_URI" class="summary-name" onclick="show_private();">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersion}/rest'"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/</code><code class="variable-ellipsis">...</code></code> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="DEFAULT_METHOD_DOC"></a><span class="summary-name">DEFAULT_METHOD_DOC</span> = <code title="'A description of how to use this function'"><code class="variable-quote">'</code><code class="variable-string">A description of how to use this function</code><code class="variable-quote">'</code></code> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="STACK_QUERY_PARAMETERS"></a><span class="summary-name">STACK_QUERY_PARAMETERS</span> = <code title="['trace', 'pp', 'userip', 'strict']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">trace</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">pp</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">userip</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">strict</code><code class="variable-quote">'</code><code class="variable-group">]</code></code> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="apiclient.discovery-module.html#RESERVED_WORDS" class="summary-name" onclick="show_private();">RESERVED_WORDS</a> = <code title="['and', |
| 'assert', |
| 'break', |
| 'class', |
| 'continue', |
| 'def', |
| 'del', |
| 'elif', |
| ..."><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">and</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">assert</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">break</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">class</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">continue</code><code class="variable-ellipsis">...</code></code> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a href="apiclient.discovery-module.html#MULTIPLIERS" class="summary-name" onclick="show_private();">MULTIPLIERS</a> = <code title="{'GB': 1073741824, 'KB': 1024, 'MB': 1048576, 'TB': 1099511627776}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">GB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1073741824<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">KB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1024<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">MB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1048576<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">T</code><code class="variable-ellipsis">...</code></code> |
| </td> |
| </tr> |
| <tr class="private"> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'apiclient'"><code class="variable-quote">'</code><code class="variable-string">apiclient</code><code class="variable-quote">'</code></code> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== FUNCTION DETAILS ==================== --> |
| <a name="section-FunctionDetails"></a> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td colspan="2" class="table-header"> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| <tr valign="top"> |
| <td align="left"><span class="table-header">Function Details</span></td> |
| <td align="right" valign="top" |
| ><span class="options">[<a href="#section-FunctionDetails" |
| class="privatelink" onclick="toggle_private();" |
| >hide private</a>]</span></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <a name="fix_method_name"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Fix method names to avoid reserved word conflicts. |
| |
| Args: |
| name: string, method name. |
| |
| Returns: |
| The name with a '_' prefixed if the name is a reserved word. |
| |
| </pre> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="_add_query_parameter"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_add_query_parameter</span>(<span class="sig-arg">url</span>, |
| <span class="sig-arg">name</span>, |
| <span class="sig-arg">value</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Adds a query parameter to a url. |
| |
| Replaces the current value if it already exists in the URL. |
| |
| Args: |
| url: string, url to add the query parameter to. |
| name: string, query parameter name. |
| value: string, query parameter value. |
| |
| Returns: |
| Updated query parameter. Does not update the url if value is None. |
| |
| </pre> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="key2param"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Converts key names into parameter names. |
| |
| For example, converting "max-results" -> "max_results" |
| |
| Args: |
| key: string, the method key name. |
| |
| Returns: |
| A safe method name based on the key name. |
| |
| </pre> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="build"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>, |
| <span class="sig-arg">version</span>, |
| <span class="sig-arg">http</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersio</code><code class="variable-ellipsis">...</code></span>, |
| <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">model</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">requestBuilder</span>=<span class="sig-default"><class 'apiclient.http.HttpRequest'></span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Construct a Resource for interacting with an API. |
| |
| Construct a Resource object for interacting with an API. The serviceName and |
| version are the names from the Discovery service. |
| |
| Args: |
| serviceName: string, name of the service. |
| version: string, the version of the service. |
| http: httplib2.Http, An instance of httplib2.Http or something that acts |
| like it that HTTP requests will be made through. |
| discoveryServiceUrl: string, a URI Template that points to the location of |
| the discovery service. It should have two parameters {api} and |
| {apiVersion} that when filled in produce an absolute URI to the discovery |
| document for that service. |
| developerKey: string, key obtained from |
| https://code.google.com/apis/console. |
| model: apiclient.Model, converts to and from the wire format. |
| requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP |
| request. |
| |
| Returns: |
| A Resource object with methods for interacting with the service. |
| |
| </pre> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="build_from_document"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>, |
| <span class="sig-arg">base</span>, |
| <span class="sig-arg">future</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">http</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">model</span>=<span class="sig-default">None</span>, |
| <span class="sig-arg">requestBuilder</span>=<span class="sig-default"><class 'apiclient.http.HttpRequest'></span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Create a Resource for interacting with an API. |
| |
| Same as `build()`, but constructs the Resource object from a discovery |
| document that is it given, as opposed to retrieving one over HTTP. |
| |
| Args: |
| service: string, discovery document. |
| base: string, base URI for all HTTP requests, usually the discovery URI. |
| future: string, discovery document with future capabilities (deprecated). |
| http: httplib2.Http, An instance of httplib2.Http or something that acts |
| like it that HTTP requests will be made through. |
| developerKey: string, Key for controlling API usage, generated |
| from the API Console. |
| model: Model class instance that serializes and de-serializes requests and |
| responses. |
| requestBuilder: Takes an http request and packages it up to be executed. |
| |
| Returns: |
| A Resource object with methods for interacting with the service. |
| |
| </pre> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="_cast"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>, |
| <span class="sig-arg">schema_type</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Convert value to a string based on JSON Schema type. |
| |
| See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on |
| JSON Schema. |
| |
| Args: |
| value: any, the value to convert |
| schema_type: string, the type that value should be interpreted as |
| |
| Returns: |
| A string representation of 'value' based on the schema_type. |
| |
| </pre> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="_media_size_to_long"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Convert a string media size, such as 10GB or 3TB into an integer. |
| |
| Args: |
| maxSize: string, size as a string, such as 2MB or 7GB. |
| |
| Returns: |
| The size as an integer value. |
| |
| </pre> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="_createResource"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_createResource</span>(<span class="sig-arg">http</span>, |
| <span class="sig-arg">baseUrl</span>, |
| <span class="sig-arg">model</span>, |
| <span class="sig-arg">requestBuilder</span>, |
| <span class="sig-arg">developerKey</span>, |
| <span class="sig-arg">resourceDesc</span>, |
| <span class="sig-arg">rootDesc</span>, |
| <span class="sig-arg">schema</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_createResource">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Build a Resource from the API description. |
| |
| Args: |
| http: httplib2.Http, Object to make http requests with. |
| baseUrl: string, base URL for the API. All requests are relative to this |
| URI. |
| model: apiclient.Model, converts to and from the wire format. |
| requestBuilder: class or callable that instantiates an |
| apiclient.HttpRequest object. |
| developerKey: string, key obtained from |
| https://code.google.com/apis/console |
| resourceDesc: object, section of deserialized discovery document that |
| describes a resource. Note that the top level discovery document |
| is considered a resource. |
| rootDesc: object, the entire deserialized discovery document. |
| schema: object, mapping of schema names to schema descriptions. |
| |
| Returns: |
| An instance of Resource with all the methods attached for interacting with |
| that resource. |
| |
| </pre> |
| <dl class="fields"> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== VARIABLES DETAILS ==================== --> |
| <a name="section-VariablesDetails"></a> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td colspan="2" class="table-header"> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| <tr valign="top"> |
| <td align="left"><span class="table-header">Variables Details</span></td> |
| <td align="right" valign="top" |
| ><span class="options">[<a href="#section-VariablesDetails" |
| class="privatelink" onclick="toggle_private();" |
| >hide private</a>]</span></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <a name="DISCOVERY_URI"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">DISCOVERY_URI</h3> |
| |
| <dl class="fields"> |
| </dl> |
| <dl class="fields"> |
| <dt>Value:</dt> |
| <dd><table><tr><td><pre class="variable"> |
| <code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersion}/rest</code><code class="variable-quote">'</code> |
| </pre></td></tr></table> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="RESERVED_WORDS"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">RESERVED_WORDS</h3> |
| |
| <dl class="fields"> |
| </dl> |
| <dl class="fields"> |
| <dt>Value:</dt> |
| <dd><table><tr><td><pre class="variable"> |
| <code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">and</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
| <code class="variable-quote">'</code><code class="variable-string">assert</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
| <code class="variable-quote">'</code><code class="variable-string">break</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
| <code class="variable-quote">'</code><code class="variable-string">class</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
| <code class="variable-quote">'</code><code class="variable-string">continue</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
| <code class="variable-quote">'</code><code class="variable-string">def</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
| <code class="variable-quote">'</code><code class="variable-string">del</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
| <code class="variable-quote">'</code><code class="variable-string">elif</code><code class="variable-quote">'</code><code class="variable-op">,</code> |
| <code class="variable-ellipsis">...</code> |
| </pre></td></tr></table> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="MULTIPLIERS"></a> |
| <div class="private"> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <h3 class="epydoc">MULTIPLIERS</h3> |
| |
| <dl class="fields"> |
| </dl> |
| <dl class="fields"> |
| <dt>Value:</dt> |
| <dd><table><tr><td><pre class="variable"> |
| <code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">GB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1073741824<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">KB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1024<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">MB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1048576<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">TB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1099511627776<code class="variable-group">}</code> |
| </pre></td></tr></table> |
| </dd> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <th class="navbar" width="100%"></th> |
| </tr> |
| </table> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| <tr> |
| <td align="left" class="footer"> |
| Generated by Epydoc 3.0.1 on Thu Jul 12 10:44:08 2012 |
| </td> |
| <td align="right" class="footer"> |
| <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| >http://epydoc.sourceforge.net</a> |
| </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| <!-- |
| // Private objects are initially displayed (because if |
| // javascript is turned off then we want them to be |
| // visible); but by default, we want to hide them. So hide |
| // them unless we have a cookie that says to show them. |
| checkCookie(); |
| // --> |
| </script> |
| </body> |
| </html> |