| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module apiclient.discovery</title> |
| </head><body bgcolor="#f0f0f8"> |
| |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
| <tr bgcolor="#7799ee"> |
| <td valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.discovery</strong></big></big></font></td |
| ><td align=right valign=bottom |
| ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiclient-release/apiclient/discovery.py">/home/jcgregorio/projects/apiclient-release/apiclient/discovery.py</a></font></td></tr></table> |
| <p><tt>Client for discovery based APIs<br> |
| <br> |
| A client library for Google's discovery based APIs.</tt></p> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#aa55cc"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httplib2.html">httplib2</a><br> |
| <a href="logging.html">logging</a><br> |
| </td><td width="25%" valign=top><a href="os.html">os</a><br> |
| <a href="re.html">re</a><br> |
| </td><td width="25%" valign=top><a href="simplejson.html">simplejson</a><br> |
| <a href="uritemplate.html">uritemplate</a><br> |
| </td><td width="25%" valign=top><a href="urllib.html">urllib</a><br> |
| <a href="urlparse.html">urlparse</a><br> |
| </td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#eeaa77"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> |
| <td width="100%"><dl><dt><a name="-build"><strong>build</strong></a>(serviceName, version, http<font color="#909090">=None</font>, discoveryServiceUrl<font color="#909090">='https://www.googleapis.com/discovery/v0.3/describe/{api}/{apiVersion}'</font>, developerKey<font color="#909090">=None</font>, model<font color="#909090">=None</font>, requestBuilder<font color="#909090">=<class 'apiclient.http.HttpRequest'></font>)</dt><dd><tt>Construct a Resource for interacting with an API.<br> |
| <br> |
| Construct a Resource object for interacting with<br> |
| an API. The serviceName and version are the<br> |
| names from the Discovery service.<br> |
| <br> |
| Args:<br> |
| serviceName: string, name of the service<br> |
| version: string, the version of the service<br> |
| discoveryServiceUrl: string, a URI Template that points to<br> |
| the location of the discovery service. It should have two<br> |
| parameters {api} and {apiVersion} that when filled in<br> |
| produce an absolute URI to the discovery document for<br> |
| that service.<br> |
| developerKey: string, key obtained<br> |
| from https://code.google.com/apis/console<br> |
| model: apiclient.Model, converts to and from the wire format<br> |
| requestBuilder: apiclient.http.HttpRequest, encapsulator for<br> |
| an HTTP request<br> |
| <br> |
| Returns:<br> |
| A Resource object with methods for interacting with<br> |
| the service.</tt></dd></dl> |
| <dl><dt><a name="-build_from_document"><strong>build_from_document</strong></a>(service, base, future<font color="#909090">=None</font>, http<font color="#909090">=None</font>, developerKey<font color="#909090">=None</font>, model<font color="#909090">=None</font>, requestBuilder<font color="#909090">=<class 'apiclient.http.HttpRequest'></font>)</dt><dd><tt>Create a Resource for interacting with an API.<br> |
| <br> |
| Same as `<a href="#-build">build</a>()`, but constructs the Resource object<br> |
| from a discovery document that is it given, as opposed to<br> |
| retrieving one over HTTP.<br> |
| <br> |
| Args:<br> |
| service: string, discovery document<br> |
| base: string, base URI for all HTTP requests, usually the discovery URI<br> |
| future: string, discovery document with future capabilities<br> |
| auth_discovery: dict, information about the authentication the API supports<br> |
| http: httplib2.Http, An instance of httplib2.Http or something that acts<br> |
| like it that HTTP requests will be made through.<br> |
| developerKey: string, Key for controlling API usage, generated<br> |
| from the API Console.<br> |
| model: Model class instance that serializes and<br> |
| de-serializes requests and responses.<br> |
| requestBuilder: Takes an http request and packages it up to be executed.<br> |
| <br> |
| Returns:<br> |
| A Resource object with methods for interacting with<br> |
| the service.</tt></dd></dl> |
| </td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#55aa55"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
| <td width="100%"><strong>__all__</strong> = ['build', 'build_from_document']<br> |
| <strong>__author__</strong> = '[email protected] (Joe Gregorio)'</td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#7799ee"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> |
| <td width="100%">[email protected] (Joe Gregorio)</td></tr></table> |
| </body></html> |
