Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b1cc515b93bef725389ac86401366b6f7a98b0c8 / . / docs / epy / googleapiclient.discovery-module.html
blob: c3248587e849666a8a399ca7e7b04122657f84e1 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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>googleapiclient.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 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="googleapiclient-module.html">Package&nbsp;googleapiclient</a> ::
41 Module&nbsp;discovery
42 </span>
43 </td>
44 <td>
45 <table cellpadding="0" cellspacing="0">
46 <!-- hide/show private -->
47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49 <tr><td align="right"><span class="options"
50 >[<a href="frames.html" target="_top">frames</a
51 >]&nbsp;|&nbsp;<a href="googleapiclient.discovery-module.html"
52 target="_top">no&nbsp;frames</a>]</span></td></tr>
53 </table>
54 </td>
55 </tr>
56</table>
57<!-- ==================== MODULE DESCRIPTION ==================== -->
58<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html">source&nbsp;code</a></span></p>
59<pre class="literalblock">
60Client for discovery based APIs.
61
62A client library for Google's discovery based APIs.
63
64</pre>
65
66<hr />
67<div class="fields"> <p><strong>Author:</strong>
68 jcgregorio@google.com (Joe Gregorio)
69 </p>
70</div><!-- ==================== CLASSES ==================== -->
71<a name="section-Classes"></a>
72<table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74<tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Classes</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-Classes"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr class="private">
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <a href="googleapiclient.discovery.ResourceMethodParameters-class.html" class="summary-name" onclick="show_private();">ResourceMethodParameters</a><br />
92 Represents the parameters associated with a method.
93 </td>
94 </tr>
95<tr class="private">
96 <td width="15%" align="right" valign="top" class="summary">
97 <span class="summary-type">&nbsp;</span>
98 </td><td class="summary">
99 <a href="googleapiclient.discovery.Resource-class.html" class="summary-name" onclick="show_private();">Resource</a><br />
100 A class for interacting with a resource.
101 </td>
102 </tr>
103</table>
104<!-- ==================== FUNCTIONS ==================== -->
105<a name="section-Functions"></a>
106<table class="summary" border="1" cellpadding="3"
107 cellspacing="0" width="100%" bgcolor="white">
108<tr bgcolor="#70b0f0" class="table-header">
109 <td colspan="2" class="table-header">
110 <table border="0" cellpadding="0" cellspacing="0" width="100%">
111 <tr valign="top">
112 <td align="left"><span class="table-header">Functions</span></td>
113 <td align="right" valign="top"
114 ><span class="options">[<a href="#section-Functions"
115 class="privatelink" onclick="toggle_private();"
116 >hide private</a>]</span></td>
117 </tr>
118 </table>
119 </td>
120</tr>
121<tr>
122 <td width="15%" align="right" valign="top" class="summary">
123 <span class="summary-type">&nbsp;</span>
124 </td><td class="summary">
125 <table width="100%" cellpadding="0" cellspacing="0" border="0">
126 <tr>
127 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#fix_method_name" class="summary-sig-name">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br />
128 Fix method names to avoid reserved word conflicts.</td>
129 <td align="right" valign="top">
130 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>
131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
138<tr>
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type">&nbsp;</span>
141 </td><td class="summary">
142 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <tr>
144 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#key2param" class="summary-sig-name">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br />
145 Converts key names into parameter names.</td>
146 <td align="right" valign="top">
147 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>
148
149 </td>
150 </tr>
151 </table>
152
153 </td>
154 </tr>
155<tr>
156 <td width="15%" align="right" valign="top" class="summary">
157 <span class="summary-type">&nbsp;</span>
158 </td><td class="summary">
159 <table width="100%" cellpadding="0" cellspacing="0" border="0">
160 <tr>
161 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">serviceName</span>,
162 <span class="summary-sig-arg">version</span>,
163 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
164 <span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default">DISCOVERY_URI</span>,
165 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
166 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
167 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>)</span><br />
168 Construct a Resource for interacting with an API.</td>
169 <td align="right" valign="top">
170 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>
171
172 </td>
173 </tr>
174 </table>
175
176 </td>
177 </tr>
178<tr>
179 <td width="15%" align="right" valign="top" class="summary">
180 <span class="summary-type">&nbsp;</span>
181 </td><td class="summary">
182 <table width="100%" cellpadding="0" cellspacing="0" border="0">
183 <tr>
184 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#build_from_document" class="summary-sig-name">build_from_document</a>(<span class="summary-sig-arg">service</span>,
185 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>,
186 <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
187 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
188 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
189 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
190 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>)</span><br />
191 Create a Resource for interacting with an API.</td>
192 <td align="right" valign="top">
193 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>
194
195 </td>
196 </tr>
197 </table>
198
199 </td>
200 </tr>
201<tr class="private">
202 <td width="15%" align="right" valign="top" class="summary">
203 <span class="summary-type">&nbsp;</span>
204 </td><td class="summary">
205 <table width="100%" cellpadding="0" cellspacing="0" border="0">
206 <tr>
207 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_cast" class="summary-sig-name" onclick="show_private();">_cast</a>(<span class="summary-sig-arg">value</span>,
208 <span class="summary-sig-arg">schema_type</span>)</span><br />
209 Convert value to a string based on JSON Schema type.</td>
210 <td align="right" valign="top">
211 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>
212
213 </td>
214 </tr>
215 </table>
216
217 </td>
218 </tr>
219<tr class="private">
220 <td width="15%" align="right" valign="top" class="summary">
221 <span class="summary-type">&nbsp;</span>
222 </td><td class="summary">
223 <table width="100%" cellpadding="0" cellspacing="0" border="0">
224 <tr>
225 <td><span class="summary-sig"><a href="googleapiclient.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 />
226 Convert a string media size, such as 10GB or 3TB into an integer.</td>
227 <td align="right" valign="top">
228 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>
229
230 </td>
231 </tr>
232 </table>
233
234 </td>
235 </tr>
236<tr class="private">
237 <td width="15%" align="right" valign="top" class="summary">
238 <span class="summary-type">&nbsp;</span>
239 </td><td class="summary">
240 <table width="100%" cellpadding="0" cellspacing="0" border="0">
241 <tr>
242 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_media_path_url_from_info" class="summary-sig-name" onclick="show_private();">_media_path_url_from_info</a>(<span class="summary-sig-arg">root_desc</span>,
243 <span class="summary-sig-arg">path_url</span>)</span><br />
244 Creates an absolute media path URL.</td>
245 <td align="right" valign="top">
246 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source&nbsp;code</a></span>
247
248 </td>
249 </tr>
250 </table>
251
252 </td>
253 </tr>
254<tr class="private">
255 <td width="15%" align="right" valign="top" class="summary">
256 <span class="summary-type">&nbsp;</span>
257 </td><td class="summary">
258 <table width="100%" cellpadding="0" cellspacing="0" border="0">
259 <tr>
260 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_parameters" class="summary-sig-name" onclick="show_private();">_fix_up_parameters</a>(<span class="summary-sig-arg">method_desc</span>,
261 <span class="summary-sig-arg">root_desc</span>,
262 <span class="summary-sig-arg">http_method</span>)</span><br />
263 Updates parameters of an API method with values specific to this library.</td>
264 <td align="right" valign="top">
265 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source&nbsp;code</a></span>
266
267 </td>
268 </tr>
269 </table>
270
271 </td>
272 </tr>
273<tr class="private">
274 <td width="15%" align="right" valign="top" class="summary">
275 <span class="summary-type">&nbsp;</span>
276 </td><td class="summary">
277 <table width="100%" cellpadding="0" cellspacing="0" border="0">
278 <tr>
279 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_media_upload" class="summary-sig-name" onclick="show_private();">_fix_up_media_upload</a>(<span class="summary-sig-arg">method_desc</span>,
280 <span class="summary-sig-arg">root_desc</span>,
281 <span class="summary-sig-arg">path_url</span>,
282 <span class="summary-sig-arg">parameters</span>)</span><br />
283 Updates parameters of API by adding 'media_body' if supported by method.</td>
284 <td align="right" valign="top">
285 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>
286
287 </td>
288 </tr>
289 </table>
290
291 </td>
292 </tr>
293<tr class="private">
294 <td width="15%" align="right" valign="top" class="summary">
295 <span class="summary-type">&nbsp;</span>
296 </td><td class="summary">
297 <table width="100%" cellpadding="0" cellspacing="0" border="0">
298 <tr>
299 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_fix_up_method_description" class="summary-sig-name" onclick="show_private();">_fix_up_method_description</a>(<span class="summary-sig-arg">method_desc</span>,
300 <span class="summary-sig-arg">root_desc</span>)</span><br />
301 Updates a method description in a discovery document.</td>
302 <td align="right" valign="top">
303 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>
304
305 </td>
306 </tr>
307 </table>
308
309 </td>
310 </tr>
311<tr class="private">
312 <td width="15%" align="right" valign="top" class="summary">
313 <span class="summary-type">&nbsp;</span>
314 </td><td class="summary">
315 <table width="100%" cellpadding="0" cellspacing="0" border="0">
316 <tr>
317 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#createMethod" class="summary-sig-name" onclick="show_private();">createMethod</a>(<span class="summary-sig-arg">methodName</span>,
318 <span class="summary-sig-arg">methodDesc</span>,
319 <span class="summary-sig-arg">rootDesc</span>,
320 <span class="summary-sig-arg">schema</span>)</span><br />
321 Creates a method for attaching to a Resource.</td>
322 <td align="right" valign="top">
323 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>
324
325 </td>
326 </tr>
327 </table>
328
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 <table width="100%" cellpadding="0" cellspacing="0" border="0">
336 <tr>
337 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#createNextMethod" class="summary-sig-name" onclick="show_private();">createNextMethod</a>(<span class="summary-sig-arg">methodName</span>)</span><br />
338 Creates any _next methods for attaching to a Resource.</td>
339 <td align="right" valign="top">
340 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>
341
342 </td>
343 </tr>
344 </table>
345
346 </td>
347 </tr>
348</table>
349<!-- ==================== VARIABLES ==================== -->
350<a name="section-Variables"></a>
351<table class="summary" border="1" cellpadding="3"
352 cellspacing="0" width="100%" bgcolor="white">
353<tr bgcolor="#70b0f0" class="table-header">
354 <td colspan="2" class="table-header">
355 <table border="0" cellpadding="0" cellspacing="0" width="100%">
356 <tr valign="top">
357 <td align="left"><span class="table-header">Variables</span></td>
358 <td align="right" valign="top"
359 ><span class="options">[<a href="#section-Variables"
360 class="privatelink" onclick="toggle_private();"
361 >hide private</a>]</span></td>
362 </tr>
363 </table>
364 </td>
365</tr>
366<tr class="private">
367 <td width="15%" align="right" valign="top" class="summary">
368 <span class="summary-type">&nbsp;</span>
369 </td><td class="summary">
370 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
371 </td>
372 </tr>
373<tr class="private">
374 <td width="15%" align="right" valign="top" class="summary">
375 <span class="summary-type">&nbsp;</span>
376 </td><td class="summary">
377 <a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile('{[^}]*}')">re.compile('{[^}]*}')</code>
378 </td>
379 </tr>
380<tr class="private">
381 <td width="15%" align="right" valign="top" class="summary">
382 <span class="summary-type">&nbsp;</span>
383 </td><td class="summary">
384 <a name="VARNAME"></a><span class="summary-name">VARNAME</span> = <code title="re.compile('[a-zA-Z0-9_-]+')">re.compile('[a-zA-Z0-9_-]+')</code>
385 </td>
386 </tr>
387<tr class="private">
388 <td width="15%" align="right" valign="top" class="summary">
389 <span class="summary-type">&nbsp;</span>
390 </td><td class="summary">
391 <a href="googleapiclient.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}/re\
392st'">'https://www.googleapis.com/discovery/v1/apis/<code class="variable-ellipsis">...</code></code>
393 </td>
394 </tr>
395<tr class="private">
396 <td width="15%" align="right" valign="top" class="summary">
397 <span class="summary-type">&nbsp;</span>
398 </td><td class="summary">
399 <a name="DEFAULT_METHOD_DOC"></a><span class="summary-name">DEFAULT_METHOD_DOC</span> = <code title="'A description of how to use this function'">'A description of how to use this function'</code>
400 </td>
401 </tr>
402<tr class="private">
403 <td width="15%" align="right" valign="top" class="summary">
404 <span class="summary-type">&nbsp;</span>
405 </td><td class="summary">
406 <a name="HTTP_PAYLOAD_METHODS"></a><span class="summary-name">HTTP_PAYLOAD_METHODS</span> = <code title="frozenset(['PUT', 'POST', 'PATCH'])">frozenset(['PUT', 'POST', 'PATCH'])</code>
407 </td>
408 </tr>
409<tr class="private">
410 <td width="15%" align="right" valign="top" class="summary">
411 <span class="summary-type">&nbsp;</span>
412 </td><td class="summary">
413 <a name="_MEDIA_SIZE_BIT_SHIFTS"></a><span class="summary-name">_MEDIA_SIZE_BIT_SHIFTS</span> = <code title="{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}">{'KB': 10, 'MB': 20, 'GB': 30, 'TB': 40}</code>
414 </td>
415 </tr>
416<tr class="private">
417 <td width="15%" align="right" valign="top" class="summary">
418 <span class="summary-type">&nbsp;</span>
419 </td><td class="summary">
420 <a href="googleapiclient.discovery-module.html#BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description': 'The request body.', 'type': 'object', 'required': Tru\
421e,}">{'description': 'The request bo<code class="variable-ellipsis">...</code></code>
422 </td>
423 </tr>
424<tr class="private">
425 <td width="15%" align="right" valign="top" class="summary">
426 <span class="summary-type">&nbsp;</span>
427 </td><td class="summary">
428 <a href="googleapiclient.discovery-module.html#MEDIA_BODY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'description':('The filename of the media request body, or an instanc\
429e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}">{'description':('The file<code class="variable-ellipsis">...</code></code>
430 </td>
431 </tr>
432<tr class="private">
433 <td width="15%" align="right" valign="top" class="summary">
434 <span class="summary-type">&nbsp;</span>
435 </td><td class="summary">
436 <a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETERS" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETERS</a> = <code title="frozenset(['trace', 'pp', 'userip', 'strict'])">frozenset(['trace', 'pp', 'userip', '<code class="variable-ellipsis">...</code></code>
437 </td>
438 </tr>
439<tr class="private">
440 <td width="15%" align="right" valign="top" class="summary">
441 <span class="summary-type">&nbsp;</span>
442 </td><td class="summary">
443 <a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETER_DEFAULT_VALUE" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETER_DEFAULT_VALUE</a> = <code title="{'type': 'string', 'location': 'query'}">{'type': 'string', 'loca<code class="variable-ellipsis">...</code></code>
444 </td>
445 </tr>
446<tr class="private">
447 <td width="15%" align="right" valign="top" class="summary">
448 <span class="summary-type">&nbsp;</span>
449 </td><td class="summary">
450 <a name="RESERVED_WORDS"></a><span class="summary-name">RESERVED_WORDS</span> = <code title="frozenset(['body'])">frozenset(['body'])</code>
451 </td>
452 </tr>
453</table>
454<!-- ==================== FUNCTION DETAILS ==================== -->
455<a name="section-FunctionDetails"></a>
456<table class="details" border="1" cellpadding="3"
457 cellspacing="0" width="100%" bgcolor="white">
458<tr bgcolor="#70b0f0" class="table-header">
459 <td colspan="2" class="table-header">
460 <table border="0" cellpadding="0" cellspacing="0" width="100%">
461 <tr valign="top">
462 <td align="left"><span class="table-header">Function Details</span></td>
463 <td align="right" valign="top"
464 ><span class="options">[<a href="#section-FunctionDetails"
465 class="privatelink" onclick="toggle_private();"
466 >hide private</a>]</span></td>
467 </tr>
468 </table>
469 </td>
470</tr>
471</table>
472<a name="fix_method_name"></a>
473<div>
474<table class="details" border="1" cellpadding="3"
475 cellspacing="0" width="100%" bgcolor="white">
476<tr><td>
477 <table width="100%" cellpadding="0" cellspacing="0" border="0">
478 <tr valign="top"><td>
479 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
480 </h3>
481 </td><td align="right" valign="top"
482 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>&nbsp;
483 </td>
484 </tr></table>
485
486 <pre class="literalblock">
487Fix method names to avoid reserved word conflicts.
488
489Args:
490 name: string, method name.
491
492Returns:
493 The name with a '_' prefixed if the name is a reserved word.
494
495</pre>
496 <dl class="fields">
497 </dl>
498</td></tr></table>
499</div>
500<a name="key2param"></a>
501<div>
502<table class="details" border="1" cellpadding="3"
503 cellspacing="0" width="100%" bgcolor="white">
504<tr><td>
505 <table width="100%" cellpadding="0" cellspacing="0" border="0">
506 <tr valign="top"><td>
507 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
508 </h3>
509 </td><td align="right" valign="top"
510 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
511 </td>
512 </tr></table>
513
514 <pre class="literalblock">
515Converts key names into parameter names.
516
517For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
518
519Args:
520 key: string, the method key name.
521
522Returns:
523 A safe method name based on the key name.
524
525</pre>
526 <dl class="fields">
527 </dl>
528</td></tr></table>
529</div>
530<a name="build"></a>
531<div>
532<table class="details" border="1" cellpadding="3"
533 cellspacing="0" width="100%" bgcolor="white">
534<tr><td>
535 <table width="100%" cellpadding="0" cellspacing="0" border="0">
536 <tr valign="top"><td>
537 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
538 <span class="sig-arg">version</span>,
539 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
540 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default">DISCOVERY_URI</span>,
541 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
542 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
543 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>)</span>
544 </h3>
545 </td><td align="right" valign="top"
546 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
547 </td>
548 </tr></table>
549
550 <pre class="literalblock">
551Construct a Resource for interacting with an API.
552
553Construct a Resource object for interacting with an API. The serviceName and
554version are the names from the Discovery service.
555
556Args:
557 serviceName: string, name of the service.
558 version: string, the version of the service.
559 http: httplib2.Http, An instance of httplib2.Http or something that acts
560 like it that HTTP requests will be made through.
561 discoveryServiceUrl: string, a URI Template that points to the location of
562 the discovery service. It should have two parameters {api} and
563 {apiVersion} that when filled in produce an absolute URI to the discovery
564 document for that service.
565 developerKey: string, key obtained from
566 https://code.google.com/apis/console.
567 model: googleapiclient.Model, converts to and from the wire format.
568 requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP
569 request.
570
571Returns:
572 A Resource object with methods for interacting with the service.
573
574</pre>
575 <dl class="fields">
576 <dt>Decorators:</dt>
577 <dd><ul class="nomargin-top">
578 <li><code>@positional(2)</code></li>
579 </ul></dd>
580 </dl>
581</td></tr></table>
582</div>
583<a name="build_from_document"></a>
584<div>
585<table class="details" border="1" cellpadding="3"
586 cellspacing="0" width="100%" bgcolor="white">
587<tr><td>
588 <table width="100%" cellpadding="0" cellspacing="0" border="0">
589 <tr valign="top"><td>
590 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
591 <span class="sig-arg">base</span>=<span class="sig-default">None</span>,
592 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
593 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
594 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
595 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
596 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>)</span>
597 </h3>
598 </td><td align="right" valign="top"
599 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
600 </td>
601 </tr></table>
602
603 <pre class="literalblock">
604Create a Resource for interacting with an API.
605
606Same as `build()`, but constructs the Resource object from a discovery
607document that is it given, as opposed to retrieving one over HTTP.
608
609Args:
610 service: string or object, the JSON discovery document describing the API.
611 The value passed in may either be the JSON string or the deserialized
612 JSON.
613 base: string, base URI for all HTTP requests, usually the discovery URI.
614 This parameter is no longer used as rootUrl and servicePath are included
615 within the discovery document. (deprecated)
616 future: string, discovery document with future capabilities (deprecated).
617 http: httplib2.Http, An instance of httplib2.Http or something that acts
618 like it that HTTP requests will be made through.
619 developerKey: string, Key for controlling API usage, generated
620 from the API Console.
621 model: Model class instance that serializes and de-serializes requests and
622 responses.
623 requestBuilder: Takes an http request and packages it up to be executed.
624
625Returns:
626 A Resource object with methods for interacting with the service.
627
628</pre>
629 <dl class="fields">
630 <dt>Decorators:</dt>
631 <dd><ul class="nomargin-top">
632 <li><code>@positional(1)</code></li>
633 </ul></dd>
634 </dl>
635</td></tr></table>
636</div>
637<a name="_cast"></a>
638<div class="private">
639<table class="details" border="1" cellpadding="3"
640 cellspacing="0" width="100%" bgcolor="white">
641<tr><td>
642 <table width="100%" cellpadding="0" cellspacing="0" border="0">
643 <tr valign="top"><td>
644 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
645 <span class="sig-arg">schema_type</span>)</span>
646 </h3>
647 </td><td align="right" valign="top"
648 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
649 </td>
650 </tr></table>
651
652 <pre class="literalblock">
653Convert value to a string based on JSON Schema type.
654
655See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
656JSON Schema.
657
658Args:
659 value: any, the value to convert
660 schema_type: string, the type that value should be interpreted as
661
662Returns:
663 A string representation of 'value' based on the schema_type.
664
665</pre>
666 <dl class="fields">
667 </dl>
668</td></tr></table>
669</div>
670<a name="_media_size_to_long"></a>
671<div class="private">
672<table class="details" border="1" cellpadding="3"
673 cellspacing="0" width="100%" bgcolor="white">
674<tr><td>
675 <table width="100%" cellpadding="0" cellspacing="0" border="0">
676 <tr valign="top"><td>
677 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
678 </h3>
679 </td><td align="right" valign="top"
680 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
681 </td>
682 </tr></table>
683
684 <pre class="literalblock">
685Convert a string media size, such as 10GB or 3TB into an integer.
686
687Args:
688 maxSize: string, size as a string, such as 2MB or 7GB.
689
690Returns:
691 The size as an integer value.
692
693</pre>
694 <dl class="fields">
695 </dl>
696</td></tr></table>
697</div>
698<a name="_media_path_url_from_info"></a>
699<div class="private">
700<table class="details" border="1" cellpadding="3"
701 cellspacing="0" width="100%" bgcolor="white">
702<tr><td>
703 <table width="100%" cellpadding="0" cellspacing="0" border="0">
704 <tr valign="top"><td>
705 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_path_url_from_info</span>(<span class="sig-arg">root_desc</span>,
706 <span class="sig-arg">path_url</span>)</span>
707 </h3>
708 </td><td align="right" valign="top"
709 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source&nbsp;code</a></span>&nbsp;
710 </td>
711 </tr></table>
712
713 <pre class="literalblock">
714Creates an absolute media path URL.
715
716Constructed using the API root URI and service path from the discovery
717document and the relative path for the API method.
718
719Args:
720 root_desc: Dictionary; the entire original deserialized discovery document.
721 path_url: String; the relative URL for the API method. Relative to the API
722 root, which is specified in the discovery document.
723
724Returns:
725 String; the absolute URI for media upload for the API method.
726
727</pre>
728 <dl class="fields">
729 </dl>
730</td></tr></table>
731</div>
732<a name="_fix_up_parameters"></a>
733<div class="private">
734<table class="details" border="1" cellpadding="3"
735 cellspacing="0" width="100%" bgcolor="white">
736<tr><td>
737 <table width="100%" cellpadding="0" cellspacing="0" border="0">
738 <tr valign="top"><td>
739 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_parameters</span>(<span class="sig-arg">method_desc</span>,
740 <span class="sig-arg">root_desc</span>,
741 <span class="sig-arg">http_method</span>)</span>
742 </h3>
743 </td><td align="right" valign="top"
744 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source&nbsp;code</a></span>&nbsp;
745 </td>
746 </tr></table>
747
748 <pre class="literalblock">
749Updates parameters of an API method with values specific to this library.
750
751Specifically, adds whatever global parameters are specified by the API to the
752parameters for the individual method. Also adds parameters which don't
753appear in the discovery document, but are available to all discovery based
754APIs (these are listed in STACK_QUERY_PARAMETERS).
755
756SIDE EFFECTS: This updates the parameters dictionary object in the method
757description.
758
759Args:
760 method_desc: Dictionary with metadata describing an API method. Value comes
761 from the dictionary of methods stored in the 'methods' key in the
762 deserialized discovery document.
763 root_desc: Dictionary; the entire original deserialized discovery document.
764 http_method: String; the HTTP method used to call the API method described
765 in method_desc.
766
767Returns:
768 The updated Dictionary stored in the 'parameters' key of the method
769 description dictionary.
770
771</pre>
772 <dl class="fields">
773 </dl>
774</td></tr></table>
775</div>
776<a name="_fix_up_media_upload"></a>
777<div class="private">
778<table class="details" border="1" cellpadding="3"
779 cellspacing="0" width="100%" bgcolor="white">
780<tr><td>
781 <table width="100%" cellpadding="0" cellspacing="0" border="0">
782 <tr valign="top"><td>
783 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_media_upload</span>(<span class="sig-arg">method_desc</span>,
784 <span class="sig-arg">root_desc</span>,
785 <span class="sig-arg">path_url</span>,
786 <span class="sig-arg">parameters</span>)</span>
787 </h3>
788 </td><td align="right" valign="top"
789 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>&nbsp;
790 </td>
791 </tr></table>
792
793 <pre class="literalblock">
794Updates parameters of API by adding 'media_body' if supported by method.
795
796SIDE EFFECTS: If the method supports media upload and has a required body,
797sets body to be optional (required=False) instead. Also, if there is a
798'mediaUpload' in the method description, adds 'media_upload' key to
799parameters.
800
801Args:
802 method_desc: Dictionary with metadata describing an API method. Value comes
803 from the dictionary of methods stored in the 'methods' key in the
804 deserialized discovery document.
805 root_desc: Dictionary; the entire original deserialized discovery document.
806 path_url: String; the relative URL for the API method. Relative to the API
807 root, which is specified in the discovery document.
808 parameters: A dictionary describing method parameters for method described
809 in method_desc.
810
811Returns:
812 Triple (accept, max_size, media_path_url) where:
813 - accept is a list of strings representing what content types are
814 accepted for media upload. Defaults to empty list if not in the
815 discovery document.
816 - max_size is a long representing the max size in bytes allowed for a
817 media upload. Defaults to 0L if not in the discovery document.
818 - media_path_url is a String; the absolute URI for media upload for the
819 API method. Constructed using the API root URI and service path from
820 the discovery document and the relative path for the API method. If
821 media upload is not supported, this is None.
822
823</pre>
824 <dl class="fields">
825 </dl>
826</td></tr></table>
827</div>
828<a name="_fix_up_method_description"></a>
829<div class="private">
830<table class="details" border="1" cellpadding="3"
831 cellspacing="0" width="100%" bgcolor="white">
832<tr><td>
833 <table width="100%" cellpadding="0" cellspacing="0" border="0">
834 <tr valign="top"><td>
835 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_method_description</span>(<span class="sig-arg">method_desc</span>,
836 <span class="sig-arg">root_desc</span>)</span>
837 </h3>
838 </td><td align="right" valign="top"
839 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>&nbsp;
840 </td>
841 </tr></table>
842
843 <pre class="literalblock">
844Updates a method description in a discovery document.
845
846SIDE EFFECTS: Changes the parameters dictionary in the method description with
847extra parameters which are used locally.
848
849Args:
850 method_desc: Dictionary with metadata describing an API method. Value comes
851 from the dictionary of methods stored in the 'methods' key in the
852 deserialized discovery document.
853 root_desc: Dictionary; the entire original deserialized discovery document.
854
855Returns:
856 Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
857 where:
858 - path_url is a String; the relative URL for the API method. Relative to
859 the API root, which is specified in the discovery document.
860 - http_method is a String; the HTTP method used to call the API method
861 described in the method description.
862 - method_id is a String; the name of the RPC method associated with the
863 API method, and is in the method description in the 'id' key.
864 - accept is a list of strings representing what content types are
865 accepted for media upload. Defaults to empty list if not in the
866 discovery document.
867 - max_size is a long representing the max size in bytes allowed for a
868 media upload. Defaults to 0L if not in the discovery document.
869 - media_path_url is a String; the absolute URI for media upload for the
870 API method. Constructed using the API root URI and service path from
871 the discovery document and the relative path for the API method. If
872 media upload is not supported, this is None.
873
874</pre>
875 <dl class="fields">
876 </dl>
877</td></tr></table>
878</div>
879<a name="createMethod"></a>
880<div class="private">
881<table class="details" border="1" cellpadding="3"
882 cellspacing="0" width="100%" bgcolor="white">
883<tr><td>
884 <table width="100%" cellpadding="0" cellspacing="0" border="0">
885 <tr valign="top"><td>
886 <h3 class="epydoc"><span class="sig"><span class="sig-name">createMethod</span>(<span class="sig-arg">methodName</span>,
887 <span class="sig-arg">methodDesc</span>,
888 <span class="sig-arg">rootDesc</span>,
889 <span class="sig-arg">schema</span>)</span>
890 </h3>
891 </td><td align="right" valign="top"
892 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>&nbsp;
893 </td>
894 </tr></table>
895
896 <pre class="literalblock">
897Creates a method for attaching to a Resource.
898
899Args:
900 methodName: string, name of the method to use.
901 methodDesc: object, fragment of deserialized discovery document that
902 describes the method.
903 rootDesc: object, the entire deserialized discovery document.
904 schema: object, mapping of schema names to schema descriptions.
905
906</pre>
907 <dl class="fields">
908 </dl>
909</td></tr></table>
910</div>
911<a name="createNextMethod"></a>
912<div class="private">
913<table class="details" border="1" cellpadding="3"
914 cellspacing="0" width="100%" bgcolor="white">
915<tr><td>
916 <table width="100%" cellpadding="0" cellspacing="0" border="0">
917 <tr valign="top"><td>
918 <h3 class="epydoc"><span class="sig"><span class="sig-name">createNextMethod</span>(<span class="sig-arg">methodName</span>)</span>
919 </h3>
920 </td><td align="right" valign="top"
921 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>&nbsp;
922 </td>
923 </tr></table>
924
925 <pre class="literalblock">
926Creates any _next methods for attaching to a Resource.
927
928The _next methods allow for easy iteration through list() responses.
929
930Args:
931 methodName: string, name of the method to use.
932
933</pre>
934 <dl class="fields">
935 </dl>
936</td></tr></table>
937</div>
938<br />
939<!-- ==================== VARIABLES DETAILS ==================== -->
940<a name="section-VariablesDetails"></a>
941<table class="details" border="1" cellpadding="3"
942 cellspacing="0" width="100%" bgcolor="white">
943<tr bgcolor="#70b0f0" class="table-header">
944 <td colspan="2" class="table-header">
945 <table border="0" cellpadding="0" cellspacing="0" width="100%">
946 <tr valign="top">
947 <td align="left"><span class="table-header">Variables Details</span></td>
948 <td align="right" valign="top"
949 ><span class="options">[<a href="#section-VariablesDetails"
950 class="privatelink" onclick="toggle_private();"
951 >hide private</a>]</span></td>
952 </tr>
953 </table>
954 </td>
955</tr>
956</table>
957<a name="DISCOVERY_URI"></a>
958<div class="private">
959<table class="details" border="1" cellpadding="3"
960 cellspacing="0" width="100%" bgcolor="white">
961<tr><td>
962 <h3 class="epydoc">DISCOVERY_URI</h3>
963
964 <dl class="fields">
965 </dl>
966 <dl class="fields">
967 <dt>Value:</dt>
968 <dd><table><tr><td><pre class="variable">
969'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
970st'
971</pre></td></tr></table>
972</dd>
973 </dl>
974</td></tr></table>
975</div>
976<a name="BODY_PARAMETER_DEFAULT_VALUE"></a>
977<div class="private">
978<table class="details" border="1" cellpadding="3"
979 cellspacing="0" width="100%" bgcolor="white">
980<tr><td>
981 <h3 class="epydoc">BODY_PARAMETER_DEFAULT_VALUE</h3>
982
983 <dl class="fields">
984 </dl>
985 <dl class="fields">
986 <dt>Value:</dt>
987 <dd><table><tr><td><pre class="variable">
988{'description': 'The request body.', 'type': 'object', 'required': Tru<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
989e,}
990</pre></td></tr></table>
991</dd>
992 </dl>
993</td></tr></table>
994</div>
995<a name="MEDIA_BODY_PARAMETER_DEFAULT_VALUE"></a>
996<div class="private">
997<table class="details" border="1" cellpadding="3"
998 cellspacing="0" width="100%" bgcolor="white">
999<tr><td>
1000 <h3 class="epydoc">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</h3>
1001
1002 <dl class="fields">
1003 </dl>
1004 <dl class="fields">
1005 <dt>Value:</dt>
1006 <dd><table><tr><td><pre class="variable">
1007{'description':('The filename of the media request body, or an instanc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1008e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}
1009</pre></td></tr></table>
1010</dd>
1011 </dl>
1012</td></tr></table>
1013</div>
1014<a name="STACK_QUERY_PARAMETERS"></a>
1015<div class="private">
1016<table class="details" border="1" cellpadding="3"
1017 cellspacing="0" width="100%" bgcolor="white">
1018<tr><td>
1019 <h3 class="epydoc">STACK_QUERY_PARAMETERS</h3>
1020
1021 <dl class="fields">
1022 </dl>
1023 <dl class="fields">
1024 <dt>Value:</dt>
1025 <dd><table><tr><td><pre class="variable">
1026frozenset(['trace', 'pp', 'userip', 'strict'])
1027</pre></td></tr></table>
1028</dd>
1029 </dl>
1030</td></tr></table>
1031</div>
1032<a name="STACK_QUERY_PARAMETER_DEFAULT_VALUE"></a>
1033<div class="private">
1034<table class="details" border="1" cellpadding="3"
1035 cellspacing="0" width="100%" bgcolor="white">
1036<tr><td>
1037 <h3 class="epydoc">STACK_QUERY_PARAMETER_DEFAULT_VALUE</h3>
1038
1039 <dl class="fields">
1040 </dl>
1041 <dl class="fields">
1042 <dt>Value:</dt>
1043 <dd><table><tr><td><pre class="variable">
1044{'type': 'string', 'location': 'query'}
1045</pre></td></tr></table>
1046</dd>
1047 </dl>
1048</td></tr></table>
1049</div>
1050<br />
1051<!-- ==================== NAVIGATION BAR ==================== -->
1052<table class="navbar" border="0" width="100%" cellpadding="0"
1053 bgcolor="#a0c0ff" cellspacing="0">
1054 <tr valign="middle">
1055 <!-- Home link -->
1056 <th>&nbsp;&nbsp;&nbsp;<a
1057 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1058
1059 <!-- Tree link -->
1060 <th>&nbsp;&nbsp;&nbsp;<a
1061 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1062
1063 <!-- Index link -->
1064 <th>&nbsp;&nbsp;&nbsp;<a
1065 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1066
1067 <!-- Help link -->
1068 <th>&nbsp;&nbsp;&nbsp;<a
1069 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1070
1071 <th class="navbar" width="100%"></th>
1072 </tr>
1073</table>
1074<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1075 <tr>
1076 <td align="left" class="footer">
1077 Generated by Epydoc 3.0.1 on Thu Apr 24 15:46:09 2014
1078 </td>
1079 <td align="right" class="footer">
1080 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1081 >http://epydoc.sourceforge.net</a>
1082 </td>
1083 </tr>
1084</table>
1085
1086<script type="text/javascript">
1087 <!--
1088 // Private objects are initially displayed (because if
1089 // javascript is turned off then we want them to be
1090 // visible); but by default, we want to hide them. So hide
1091 // them unless we have a cookie that says to show them.
1092 checkCookie();
1093 // -->
1094</script>
1095</body>
1096</html>