Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a84516743cd7751c0ded783bb9d10fb5e84f56a8 / . / docs / apiclient.discovery.html
blob: 7de89cf250c8a829a76a422072b955472178d786 [file] [log] [blame]
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module apiclient.discovery</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.discovery</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregorioa8451672011-09-15 09:53:21 -0400[diff] [blame^]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/discovery.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/discovery.py</a></font></td></tr></table>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]12 <p><tt>Client&nbsp;for&nbsp;discovery&nbsp;based&nbsp;APIs<br>
13&nbsp;<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]14A&nbsp;client&nbsp;library&nbsp;for&nbsp;Google's&nbsp;discovery&nbsp;based&nbsp;APIs.</tt></p>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]15<p>
16<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
17<tr bgcolor="#aa55cc">
18<td colspan=3 valign=bottom>&nbsp;<br>
19<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
20
21<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]22<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="copy.html">copy</a><br>
23<a href="httplib2.html">httplib2</a><br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]24<a href="logging.html">logging</a><br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]25</td><td width="25%" valign=top><a href="apiclient.mimeparse.html">apiclient.mimeparse</a><br>
26<a href="mimetypes.html">mimetypes</a><br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]27<a href="os.html">os</a><br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]28</td><td width="25%" valign=top><a href="re.html">re</a><br>
29<a href="simplejson.html">simplejson</a><br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]30<a href="uritemplate.html">uritemplate</a><br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]31</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
32<a href="urlparse.html">urlparse</a><br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]33</td></tr></table></td></tr></table><p>
34<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
35<tr bgcolor="#eeaa77">
36<td colspan=3 valign=bottom>&nbsp;<br>
37<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
38
39<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]40<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/v1/apis/{api}/{apiVersion}/rest'</font>, developerKey<font color="#909090">=None</font>, model<font color="#909090">=None</font>, requestBuilder<font color="#909090">=&lt;class 'apiclient.http.HttpRequest'&gt;</font>)</dt><dd><tt>Construct&nbsp;a&nbsp;Resource&nbsp;for&nbsp;interacting&nbsp;with&nbsp;an&nbsp;API.<br>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500[diff] [blame]41&nbsp;<br>
42Construct&nbsp;a&nbsp;Resource&nbsp;object&nbsp;for&nbsp;interacting&nbsp;with<br>
43an&nbsp;API.&nbsp;The&nbsp;serviceName&nbsp;and&nbsp;version&nbsp;are&nbsp;the<br>
44names&nbsp;from&nbsp;the&nbsp;Discovery&nbsp;service.<br>
45&nbsp;<br>
46Args:<br>
47&nbsp;&nbsp;serviceName:&nbsp;string,&nbsp;name&nbsp;of&nbsp;the&nbsp;service<br>
48&nbsp;&nbsp;version:&nbsp;string,&nbsp;the&nbsp;version&nbsp;of&nbsp;the&nbsp;service<br>
49&nbsp;&nbsp;discoveryServiceUrl:&nbsp;string,&nbsp;a&nbsp;URI&nbsp;Template&nbsp;that&nbsp;points&nbsp;to<br>
50&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;location&nbsp;of&nbsp;the&nbsp;discovery&nbsp;service.&nbsp;It&nbsp;should&nbsp;have&nbsp;two<br>
51&nbsp;&nbsp;&nbsp;&nbsp;parameters&nbsp;{api}&nbsp;and&nbsp;{apiVersion}&nbsp;that&nbsp;when&nbsp;filled&nbsp;in<br>
52&nbsp;&nbsp;&nbsp;&nbsp;produce&nbsp;an&nbsp;absolute&nbsp;URI&nbsp;to&nbsp;the&nbsp;discovery&nbsp;document&nbsp;for<br>
53&nbsp;&nbsp;&nbsp;&nbsp;that&nbsp;service.<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]54&nbsp;&nbsp;developerKey:&nbsp;string,&nbsp;key&nbsp;obtained<br>
55&nbsp;&nbsp;&nbsp;&nbsp;from&nbsp;https://code.google.com/apis/console<br>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500[diff] [blame]56&nbsp;&nbsp;model:&nbsp;apiclient.Model,&nbsp;converts&nbsp;to&nbsp;and&nbsp;from&nbsp;the&nbsp;wire&nbsp;format<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -0500[diff] [blame]57&nbsp;&nbsp;requestBuilder:&nbsp;apiclient.http.HttpRequest,&nbsp;encapsulator&nbsp;for<br>
58&nbsp;&nbsp;&nbsp;&nbsp;an&nbsp;HTTP&nbsp;request<br>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500[diff] [blame]59&nbsp;<br>
60Returns:<br>
61&nbsp;&nbsp;A&nbsp;Resource&nbsp;object&nbsp;with&nbsp;methods&nbsp;for&nbsp;interacting&nbsp;with<br>
62&nbsp;&nbsp;the&nbsp;service.</tt></dd></dl>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]63 <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">=&lt;class 'apiclient.http.HttpRequest'&gt;</font>)</dt><dd><tt>Create&nbsp;a&nbsp;Resource&nbsp;for&nbsp;interacting&nbsp;with&nbsp;an&nbsp;API.<br>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500[diff] [blame]64&nbsp;<br>
65Same&nbsp;as&nbsp;`<a href="#-build">build</a>()`,&nbsp;but&nbsp;constructs&nbsp;the&nbsp;Resource&nbsp;object<br>
66from&nbsp;a&nbsp;discovery&nbsp;document&nbsp;that&nbsp;is&nbsp;it&nbsp;given,&nbsp;as&nbsp;opposed&nbsp;to<br>
67retrieving&nbsp;one&nbsp;over&nbsp;HTTP.<br>
68&nbsp;<br>
69Args:<br>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]70&nbsp;&nbsp;service:&nbsp;string,&nbsp;discovery&nbsp;document<br>
71&nbsp;&nbsp;base:&nbsp;string,&nbsp;base&nbsp;URI&nbsp;for&nbsp;all&nbsp;HTTP&nbsp;requests,&nbsp;usually&nbsp;the&nbsp;discovery&nbsp;URI<br>
72&nbsp;&nbsp;future:&nbsp;string,&nbsp;discovery&nbsp;document&nbsp;with&nbsp;future&nbsp;capabilities<br>
73&nbsp;&nbsp;auth_discovery:&nbsp;dict,&nbsp;information&nbsp;about&nbsp;the&nbsp;authentication&nbsp;the&nbsp;API&nbsp;supports<br>
74&nbsp;&nbsp;http:&nbsp;httplib2.Http,&nbsp;An&nbsp;instance&nbsp;of&nbsp;httplib2.Http&nbsp;or&nbsp;something&nbsp;that&nbsp;acts<br>
75&nbsp;&nbsp;&nbsp;&nbsp;like&nbsp;it&nbsp;that&nbsp;HTTP&nbsp;requests&nbsp;will&nbsp;be&nbsp;made&nbsp;through.<br>
76&nbsp;&nbsp;developerKey:&nbsp;string,&nbsp;Key&nbsp;for&nbsp;controlling&nbsp;API&nbsp;usage,&nbsp;generated<br>
77&nbsp;&nbsp;&nbsp;&nbsp;from&nbsp;the&nbsp;API&nbsp;Console.<br>
78&nbsp;&nbsp;model:&nbsp;Model&nbsp;class&nbsp;instance&nbsp;that&nbsp;serializes&nbsp;and<br>
79&nbsp;&nbsp;&nbsp;&nbsp;de-serializes&nbsp;requests&nbsp;and&nbsp;responses.<br>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500[diff] [blame]80&nbsp;&nbsp;requestBuilder:&nbsp;Takes&nbsp;an&nbsp;http&nbsp;request&nbsp;and&nbsp;packages&nbsp;it&nbsp;up&nbsp;to&nbsp;be&nbsp;executed.<br>
81&nbsp;<br>
82Returns:<br>
83&nbsp;&nbsp;A&nbsp;Resource&nbsp;object&nbsp;with&nbsp;methods&nbsp;for&nbsp;interacting&nbsp;with<br>
84&nbsp;&nbsp;the&nbsp;service.</tt></dd></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]85</td></tr></table><p>
86<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
87<tr bgcolor="#55aa55">
88<td colspan=3 valign=bottom>&nbsp;<br>
89<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
90
91<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500[diff] [blame]92<td width="100%"><strong>__all__</strong> = ['build', 'build_from_document']<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]93<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
94<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
95<tr bgcolor="#7799ee">
96<td colspan=3 valign=bottom>&nbsp;<br>
97<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
98
99<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
100<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
101</body></html>