Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / apiclient.discovery-module.html
blob: cabbe2c1b30414ca13a6b9ae69280f94aa93ce53 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame^]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>apiclient.discovery</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="apiclient-module.html">Package&nbsp;apiclient</a> ::
38 Module&nbsp;discovery
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="apiclient.discovery-module.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<!-- ==================== MODULE DESCRIPTION ==================== -->
55<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.discovery-pysrc.html">source&nbsp;code</a></span></p>
56<pre class="literalblock">
57Client for discovery based APIs
58
59A client library for Google's discovery based APIs.
60
61</pre>
62
63<hr />
64<div class="fields"> <p><strong>Author:</strong>
65 jcgregorio@google.com (Joe Gregorio)
66 </p>
67</div><!-- ==================== FUNCTIONS ==================== -->
68<a name="section-Functions"></a>
69<table class="summary" border="1" cellpadding="3"
70 cellspacing="0" width="100%" bgcolor="white">
71<tr bgcolor="#70b0f0" class="table-header">
72 <td colspan="2" class="table-header">
73 <table border="0" cellpadding="0" cellspacing="0" width="100%">
74 <tr valign="top">
75 <td align="left"><span class="table-header">Functions</span></td>
76 <td align="right" valign="top"
77 ><span class="options">[<a href="#section-Functions"
78 class="privatelink" onclick="toggle_private();"
79 >hide private</a>]</span></td>
80 </tr>
81 </table>
82 </td>
83</tr>
84<tr class="private">
85 <td width="15%" align="right" valign="top" class="summary">
86 <span class="summary-type">&nbsp;</span>
87 </td><td class="summary">
88 <table width="100%" cellpadding="0" cellspacing="0" border="0">
89 <tr>
90 <td><span class="summary-sig"><a name="_fix_method_name"></a><span class="summary-sig-name">_fix_method_name</span>(<span class="summary-sig-arg">name</span>)</span></td>
91 <td align="right" valign="top">
92 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_fix_method_name">source&nbsp;code</a></span>
93
94 </td>
95 </tr>
96 </table>
97
98 </td>
99 </tr>
100<tr class="private">
101 <td width="15%" align="right" valign="top" class="summary">
102 <span class="summary-type">&nbsp;</span>
103 </td><td class="summary">
104 <table width="100%" cellpadding="0" cellspacing="0" border="0">
105 <tr>
106 <td><span class="summary-sig"><a name="_write_headers"></a><span class="summary-sig-name">_write_headers</span>(<span class="summary-sig-arg">self</span>)</span></td>
107 <td align="right" valign="top">
108 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_write_headers">source&nbsp;code</a></span>
109
110 </td>
111 </tr>
112 </table>
113
114 </td>
115 </tr>
116<tr class="private">
117 <td width="15%" align="right" valign="top" class="summary">
118 <span class="summary-type">&nbsp;</span>
119 </td><td class="summary">
120 <table width="100%" cellpadding="0" cellspacing="0" border="0">
121 <tr>
122 <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>,
123 <span class="summary-sig-arg">name</span>,
124 <span class="summary-sig-arg">value</span>)</span><br />
125 Adds a query parameter to a url.</td>
126 <td align="right" valign="top">
127 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source&nbsp;code</a></span>
128
129 </td>
130 </tr>
131 </table>
132
133 </td>
134 </tr>
135<tr class="private">
136 <td width="15%" align="right" valign="top" class="summary">
137 <span class="summary-type">&nbsp;</span>
138 </td><td class="summary">
139 <table width="100%" cellpadding="0" cellspacing="0" border="0">
140 <tr>
141 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#key2param" class="summary-sig-name" onclick="show_private();">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br />
142 Converts key names into parameter names.</td>
143 <td align="right" valign="top">
144 <span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>
145
146 </td>
147 </tr>
148 </table>
149
150 </td>
151 </tr>
152<tr>
153 <td width="15%" align="right" valign="top" class="summary">
154 <span class="summary-type">&nbsp;</span>
155 </td><td class="summary">
156 <table width="100%" cellpadding="0" cellspacing="0" border="0">
157 <tr>
158 <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>,
159 <span class="summary-sig-arg">version</span>,
160 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
161 <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>,
162 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
163 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
164 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">&lt;class 'apiclient.http.HttpRequest'&gt;</span>)</span><br />
165 Construct a Resource for interacting with an API.</td>
166 <td align="right" valign="top">
167 <span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>
168
169 </td>
170 </tr>
171 </table>
172
173 </td>
174 </tr>
175<tr>
176 <td width="15%" align="right" valign="top" class="summary">
177 <span class="summary-type">&nbsp;</span>
178 </td><td class="summary">
179 <table width="100%" cellpadding="0" cellspacing="0" border="0">
180 <tr>
181 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build_from_document" class="summary-sig-name">build_from_document</a>(<span class="summary-sig-arg">service</span>,
182 <span class="summary-sig-arg">base</span>,
183 <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
184 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
185 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
186 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
187 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">&lt;class 'apiclient.http.HttpRequest'&gt;</span>)</span><br />
188 Create a Resource for interacting with an API.</td>
189 <td align="right" valign="top">
190 <span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>
191
192 </td>
193 </tr>
194 </table>
195
196 </td>
197 </tr>
198<tr class="private">
199 <td width="15%" align="right" valign="top" class="summary">
200 <span class="summary-type">&nbsp;</span>
201 </td><td class="summary">
202 <table width="100%" cellpadding="0" cellspacing="0" border="0">
203 <tr>
204 <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>,
205 <span class="summary-sig-arg">schema_type</span>)</span><br />
206 Convert value to a string based on JSON Schema type.</td>
207 <td align="right" valign="top">
208 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>
209
210 </td>
211 </tr>
212 </table>
213
214 </td>
215 </tr>
216<tr class="private">
217 <td width="15%" align="right" valign="top" class="summary">
218 <span class="summary-type">&nbsp;</span>
219 </td><td class="summary">
220 <table width="100%" cellpadding="0" cellspacing="0" border="0">
221 <tr>
222 <td><span class="summary-sig"><a name="_media_size_to_long"></a><span class="summary-sig-name">_media_size_to_long</span>(<span class="summary-sig-arg">maxSize</span>)</span><br />
223 Convert a string media size, such as 10GB or 3TB into an integer.</td>
224 <td align="right" valign="top">
225 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>
226
227 </td>
228 </tr>
229 </table>
230
231 </td>
232 </tr>
233<tr class="private">
234 <td width="15%" align="right" valign="top" class="summary">
235 <span class="summary-type">&nbsp;</span>
236 </td><td class="summary">
237 <table width="100%" cellpadding="0" cellspacing="0" border="0">
238 <tr>
239 <td><span class="summary-sig"><a name="createResource"></a><span class="summary-sig-name">createResource</span>(<span class="summary-sig-arg">http</span>,
240 <span class="summary-sig-arg">baseUrl</span>,
241 <span class="summary-sig-arg">model</span>,
242 <span class="summary-sig-arg">requestBuilder</span>,
243 <span class="summary-sig-arg">developerKey</span>,
244 <span class="summary-sig-arg">resourceDesc</span>,
245 <span class="summary-sig-arg">futureDesc</span>,
246 <span class="summary-sig-arg">schema</span>)</span></td>
247 <td align="right" valign="top">
248 <span class="codelink"><a href="apiclient.discovery-pysrc.html#createResource">source&nbsp;code</a></span>
249
250 </td>
251 </tr>
252 </table>
253
254 </td>
255 </tr>
256</table>
257<!-- ==================== VARIABLES ==================== -->
258<a name="section-Variables"></a>
259<table class="summary" border="1" cellpadding="3"
260 cellspacing="0" width="100%" bgcolor="white">
261<tr bgcolor="#70b0f0" class="table-header">
262 <td colspan="2" class="table-header">
263 <table border="0" cellpadding="0" cellspacing="0" width="100%">
264 <tr valign="top">
265 <td align="left"><span class="table-header">Variables</span></td>
266 <td align="right" valign="top"
267 ><span class="options">[<a href="#section-Variables"
268 class="privatelink" onclick="toggle_private();"
269 >hide private</a>]</span></td>
270 </tr>
271 </table>
272 </td>
273</tr>
274<tr class="private">
275 <td width="15%" align="right" valign="top" class="summary">
276 <span class="summary-type">&nbsp;</span>
277 </td><td class="summary">
278 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
279 </td>
280 </tr>
281<tr class="private">
282 <td width="15%" align="right" valign="top" class="summary">
283 <span class="summary-type">&nbsp;</span>
284 </td><td class="summary">
285 <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>
286 </td>
287 </tr>
288<tr class="private">
289 <td width="15%" align="right" valign="top" class="summary">
290 <span class="summary-type">&nbsp;</span>
291 </td><td class="summary">
292 <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>
293 </td>
294 </tr>
295<tr class="private">
296 <td width="15%" align="right" valign="top" class="summary">
297 <span class="summary-type">&nbsp;</span>
298 </td><td class="summary">
299 <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>
300 </td>
301 </tr>
302<tr class="private">
303 <td width="15%" align="right" valign="top" class="summary">
304 <span class="summary-type">&nbsp;</span>
305 </td><td class="summary">
306 <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>
307 </td>
308 </tr>
309<tr class="private">
310 <td width="15%" align="right" valign="top" class="summary">
311 <span class="summary-type">&nbsp;</span>
312 </td><td class="summary">
313 <a href="apiclient.discovery-module.html#STACK_QUERY_PARAMETERS" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETERS</a> = <code title="['trace', 'fields', 'pp', 'prettyPrint', 'userIp', '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">fields</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">prettyPrin</code><code class="variable-ellipsis">...</code></code>
314 </td>
315 </tr>
316<tr class="private">
317 <td width="15%" align="right" valign="top" class="summary">
318 <span class="summary-type">&nbsp;</span>
319 </td><td class="summary">
320 <a href="apiclient.discovery-module.html#RESERVED_WORDS" class="summary-name" onclick="show_private();">RESERVED_WORDS</a> = <code title="['and',
321 'assert',
322 'break',
323 'class',
324 'continue',
325 'def',
326 'del',
327 'elif',
328..."><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>
329 </td>
330 </tr>
331<tr class="private">
332 <td width="15%" align="right" valign="top" class="summary">
333 <span class="summary-type">&nbsp;</span>
334 </td><td class="summary">
335 <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>
336 </td>
337 </tr>
338<tr class="private">
339 <td width="15%" align="right" valign="top" class="summary">
340 <span class="summary-type">&nbsp;</span>
341 </td><td class="summary">
342 <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>
343 </td>
344 </tr>
345</table>
346<!-- ==================== FUNCTION DETAILS ==================== -->
347<a name="section-FunctionDetails"></a>
348<table class="details" border="1" cellpadding="3"
349 cellspacing="0" width="100%" bgcolor="white">
350<tr bgcolor="#70b0f0" class="table-header">
351 <td colspan="2" class="table-header">
352 <table border="0" cellpadding="0" cellspacing="0" width="100%">
353 <tr valign="top">
354 <td align="left"><span class="table-header">Function Details</span></td>
355 <td align="right" valign="top"
356 ><span class="options">[<a href="#section-FunctionDetails"
357 class="privatelink" onclick="toggle_private();"
358 >hide private</a>]</span></td>
359 </tr>
360 </table>
361 </td>
362</tr>
363</table>
364<a name="_add_query_parameter"></a>
365<div class="private">
366<table class="details" border="1" cellpadding="3"
367 cellspacing="0" width="100%" bgcolor="white">
368<tr><td>
369 <table width="100%" cellpadding="0" cellspacing="0" border="0">
370 <tr valign="top"><td>
371 <h3 class="epydoc"><span class="sig"><span class="sig-name">_add_query_parameter</span>(<span class="sig-arg">url</span>,
372 <span class="sig-arg">name</span>,
373 <span class="sig-arg">value</span>)</span>
374 </h3>
375 </td><td align="right" valign="top"
376 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source&nbsp;code</a></span>&nbsp;
377 </td>
378 </tr></table>
379
380 <pre class="literalblock">
381Adds a query parameter to a url.
382
383Replaces the current value if it already exists in the URL.
384
385Args:
386 url: string, url to add the query parameter to.
387 name: string, query parameter name.
388 value: string, query parameter value.
389
390Returns:
391 Updated query parameter. Does not update the url if value is None.
392
393</pre>
394 <dl class="fields">
395 </dl>
396</td></tr></table>
397</div>
398<a name="key2param"></a>
399<div class="private">
400<table class="details" border="1" cellpadding="3"
401 cellspacing="0" width="100%" bgcolor="white">
402<tr><td>
403 <table width="100%" cellpadding="0" cellspacing="0" border="0">
404 <tr valign="top"><td>
405 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
406 </h3>
407 </td><td align="right" valign="top"
408 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
409 </td>
410 </tr></table>
411
412 <pre class="literalblock">
413Converts key names into parameter names.
414
415For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
416
417</pre>
418 <dl class="fields">
419 </dl>
420</td></tr></table>
421</div>
422<a name="build"></a>
423<div>
424<table class="details" border="1" cellpadding="3"
425 cellspacing="0" width="100%" bgcolor="white">
426<tr><td>
427 <table width="100%" cellpadding="0" cellspacing="0" border="0">
428 <tr valign="top"><td>
429 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
430 <span class="sig-arg">version</span>,
431 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
432 <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>,
433 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
434 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
435 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">&lt;class 'apiclient.http.HttpRequest'&gt;</span>)</span>
436 </h3>
437 </td><td align="right" valign="top"
438 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
439 </td>
440 </tr></table>
441
442 <pre class="literalblock">
443Construct a Resource for interacting with an API.
444
445Construct a Resource object for interacting with
446an API. The serviceName and version are the
447names from the Discovery service.
448
449Args:
450 serviceName: string, name of the service
451 version: string, the version of the service
452 http: httplib2.Http, An instance of httplib2.Http or something that acts
453 like it that HTTP requests will be made through.
454 discoveryServiceUrl: string, a URI Template that points to
455 the location of the discovery service. It should have two
456 parameters {api} and {apiVersion} that when filled in
457 produce an absolute URI to the discovery document for
458 that service.
459 developerKey: string, key obtained
460 from https://code.google.com/apis/console
461 model: apiclient.Model, converts to and from the wire format
462 requestBuilder: apiclient.http.HttpRequest, encapsulator for
463 an HTTP request
464
465Returns:
466 A Resource object with methods for interacting with
467 the service.
468
469</pre>
470 <dl class="fields">
471 </dl>
472</td></tr></table>
473</div>
474<a name="build_from_document"></a>
475<div>
476<table class="details" border="1" cellpadding="3"
477 cellspacing="0" width="100%" bgcolor="white">
478<tr><td>
479 <table width="100%" cellpadding="0" cellspacing="0" border="0">
480 <tr valign="top"><td>
481 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
482 <span class="sig-arg">base</span>,
483 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
484 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
485 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
486 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
487 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">&lt;class 'apiclient.http.HttpRequest'&gt;</span>)</span>
488 </h3>
489 </td><td align="right" valign="top"
490 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
491 </td>
492 </tr></table>
493
494 <pre class="literalblock">
495Create a Resource for interacting with an API.
496
497Same as `build()`, but constructs the Resource object
498from a discovery document that is it given, as opposed to
499retrieving one over HTTP.
500
501Args:
502 service: string, discovery document
503 base: string, base URI for all HTTP requests, usually the discovery URI
504 future: string, discovery document with future capabilities
505 auth_discovery: dict, information about the authentication the API supports
506 http: httplib2.Http, An instance of httplib2.Http or something that acts
507 like it that HTTP requests will be made through.
508 developerKey: string, Key for controlling API usage, generated
509 from the API Console.
510 model: Model class instance that serializes and
511 de-serializes requests and responses.
512 requestBuilder: Takes an http request and packages it up to be executed.
513
514Returns:
515 A Resource object with methods for interacting with
516 the service.
517
518</pre>
519 <dl class="fields">
520 </dl>
521</td></tr></table>
522</div>
523<a name="_cast"></a>
524<div class="private">
525<table class="details" border="1" cellpadding="3"
526 cellspacing="0" width="100%" bgcolor="white">
527<tr><td>
528 <table width="100%" cellpadding="0" cellspacing="0" border="0">
529 <tr valign="top"><td>
530 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
531 <span class="sig-arg">schema_type</span>)</span>
532 </h3>
533 </td><td align="right" valign="top"
534 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
535 </td>
536 </tr></table>
537
538 <pre class="literalblock">
539Convert value to a string based on JSON Schema type.
540
541See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
542JSON Schema.
543
544Args:
545 value: any, the value to convert
546 schema_type: string, the type that value should be interpreted as
547
548Returns:
549 A string representation of 'value' based on the schema_type.
550
551</pre>
552 <dl class="fields">
553 </dl>
554</td></tr></table>
555</div>
556<br />
557<!-- ==================== VARIABLES DETAILS ==================== -->
558<a name="section-VariablesDetails"></a>
559<table class="details" border="1" cellpadding="3"
560 cellspacing="0" width="100%" bgcolor="white">
561<tr bgcolor="#70b0f0" class="table-header">
562 <td colspan="2" class="table-header">
563 <table border="0" cellpadding="0" cellspacing="0" width="100%">
564 <tr valign="top">
565 <td align="left"><span class="table-header">Variables Details</span></td>
566 <td align="right" valign="top"
567 ><span class="options">[<a href="#section-VariablesDetails"
568 class="privatelink" onclick="toggle_private();"
569 >hide private</a>]</span></td>
570 </tr>
571 </table>
572 </td>
573</tr>
574</table>
575<a name="DISCOVERY_URI"></a>
576<div class="private">
577<table class="details" border="1" cellpadding="3"
578 cellspacing="0" width="100%" bgcolor="white">
579<tr><td>
580 <h3 class="epydoc">DISCOVERY_URI</h3>
581
582 <dl class="fields">
583 </dl>
584 <dl class="fields">
585 <dt>Value:</dt>
586 <dd><table><tr><td><pre class="variable">
587<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>
588</pre></td></tr></table>
589</dd>
590 </dl>
591</td></tr></table>
592</div>
593<a name="STACK_QUERY_PARAMETERS"></a>
594<div class="private">
595<table class="details" border="1" cellpadding="3"
596 cellspacing="0" width="100%" bgcolor="white">
597<tr><td>
598 <h3 class="epydoc">STACK_QUERY_PARAMETERS</h3>
599
600 <dl class="fields">
601 </dl>
602 <dl class="fields">
603 <dt>Value:</dt>
604 <dd><table><tr><td><pre class="variable">
605<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">fields</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">prettyPrint</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">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>
606</pre></td></tr></table>
607</dd>
608 </dl>
609</td></tr></table>
610</div>
611<a name="RESERVED_WORDS"></a>
612<div class="private">
613<table class="details" border="1" cellpadding="3"
614 cellspacing="0" width="100%" bgcolor="white">
615<tr><td>
616 <h3 class="epydoc">RESERVED_WORDS</h3>
617
618 <dl class="fields">
619 </dl>
620 <dl class="fields">
621 <dt>Value:</dt>
622 <dd><table><tr><td><pre class="variable">
623<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>
624 <code class="variable-quote">'</code><code class="variable-string">assert</code><code class="variable-quote">'</code><code class="variable-op">,</code>
625 <code class="variable-quote">'</code><code class="variable-string">break</code><code class="variable-quote">'</code><code class="variable-op">,</code>
626 <code class="variable-quote">'</code><code class="variable-string">class</code><code class="variable-quote">'</code><code class="variable-op">,</code>
627 <code class="variable-quote">'</code><code class="variable-string">continue</code><code class="variable-quote">'</code><code class="variable-op">,</code>
628 <code class="variable-quote">'</code><code class="variable-string">def</code><code class="variable-quote">'</code><code class="variable-op">,</code>
629 <code class="variable-quote">'</code><code class="variable-string">del</code><code class="variable-quote">'</code><code class="variable-op">,</code>
630 <code class="variable-quote">'</code><code class="variable-string">elif</code><code class="variable-quote">'</code><code class="variable-op">,</code>
631<code class="variable-ellipsis">...</code>
632</pre></td></tr></table>
633</dd>
634 </dl>
635</td></tr></table>
636</div>
637<a name="MULTIPLIERS"></a>
638<div class="private">
639<table class="details" border="1" cellpadding="3"
640 cellspacing="0" width="100%" bgcolor="white">
641<tr><td>
642 <h3 class="epydoc">MULTIPLIERS</h3>
643
644 <dl class="fields">
645 </dl>
646 <dl class="fields">
647 <dt>Value:</dt>
648 <dd><table><tr><td><pre class="variable">
649<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>
650</pre></td></tr></table>
651</dd>
652 </dl>
653</td></tr></table>
654</div>
655<br />
656<!-- ==================== NAVIGATION BAR ==================== -->
657<table class="navbar" border="0" width="100%" cellpadding="0"
658 bgcolor="#a0c0ff" cellspacing="0">
659 <tr valign="middle">
660
661 <!-- Tree link -->
662 <th>&nbsp;&nbsp;&nbsp;<a
663 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
664
665 <!-- Index link -->
666 <th>&nbsp;&nbsp;&nbsp;<a
667 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
668
669 <!-- Help link -->
670 <th>&nbsp;&nbsp;&nbsp;<a
671 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
672
673 <th class="navbar" width="100%"></th>
674 </tr>
675</table>
676<table border="0" cellpadding="0" cellspacing="0" width="100%%">
677 <tr>
678 <td align="left" class="footer">
679 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012
680 </td>
681 <td align="right" class="footer">
682 <a target="mainFrame" href="http://epydoc.sourceforge.net"
683 >http://epydoc.sourceforge.net</a>
684 </td>
685 </tr>
686</table>
687
688<script type="text/javascript">
689 <!--
690 // Private objects are initially displayed (because if
691 // javascript is turned off then we want them to be
692 // visible); but by default, we want to hide them. So hide
693 // them unless we have a cookie that says to show them.
694 checkCookie();
695 // -->
696</script>
697</body>
698</html>