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