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