Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / epy / googleapiclient.discovery-module.html
blob: c595b3c4e772ab5fad5b3a21b24c9861e184a636 [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">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]448 <a href="googleapiclient.discovery-module.html#V1_DISCOVERY_URI" class="summary-name" onclick="show_private();">V1_DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\
449st'">'https://www.googleapis.com/discovery/v1/ap<code class="variable-ellipsis">...</code></code>
450 </td>
451 </tr>
452<tr class="private">
453 <td width="15%" align="right" valign="top" class="summary">
454 <span class="summary-type">&nbsp;</span>
455 </td><td class="summary">
456 <a href="googleapiclient.discovery-module.html#V2_DISCOVERY_URI" class="summary-name" onclick="show_private();">V2_DISCOVERY_URI</a> = <code title="'https://{api}.googleapis.com/$discovery/rest?' 'version={apiVersion}'">'https://{api}.googleapis.com/$discovery/re<code class="variable-ellipsis">...</code></code>
457 </td>
458 </tr>
459<tr class="private">
460 <td width="15%" align="right" valign="top" class="summary">
461 <span class="summary-type">&nbsp;</span>
462 </td><td class="summary">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]463 <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>
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 name="HTTP_PAYLOAD_METHODS"></a><span class="summary-name">HTTP_PAYLOAD_METHODS</span> = <code title="frozenset(['PUT', 'POST', 'PATCH'])">frozenset(['PUT', 'POST', 'PATCH'])</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 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>
478 </td>
479 </tr>
480<tr class="private">
481 <td width="15%" align="right" valign="top" class="summary">
482 <span class="summary-type">&nbsp;</span>
483 </td><td class="summary">
484 <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\
485e,}">{'description': 'The request bo<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#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\
493e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}">{'description':('The file<code class="variable-ellipsis">...</code></code>
494 </td>
495 </tr>
496<tr class="private">
497 <td width="15%" align="right" valign="top" class="summary">
498 <span class="summary-type">&nbsp;</span>
499 </td><td class="summary">
500 <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>
501 </td>
502 </tr>
503<tr class="private">
504 <td width="15%" align="right" valign="top" class="summary">
505 <span class="summary-type">&nbsp;</span>
506 </td><td class="summary">
507 <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>
508 </td>
509 </tr>
510<tr class="private">
511 <td width="15%" align="right" valign="top" class="summary">
512 <span class="summary-type">&nbsp;</span>
513 </td><td class="summary">
514 <a name="RESERVED_WORDS"></a><span class="summary-name">RESERVED_WORDS</span> = <code title="frozenset(['body'])">frozenset(['body'])</code>
515 </td>
516 </tr>
517</table>
518<!-- ==================== FUNCTION DETAILS ==================== -->
519<a name="section-FunctionDetails"></a>
520<table class="details" border="1" cellpadding="3"
521 cellspacing="0" width="100%" bgcolor="white">
522<tr bgcolor="#70b0f0" class="table-header">
523 <td colspan="2" class="table-header">
524 <table border="0" cellpadding="0" cellspacing="0" width="100%">
525 <tr valign="top">
526 <td align="left"><span class="table-header">Function Details</span></td>
527 <td align="right" valign="top"
528 ><span class="options">[<a href="#section-FunctionDetails"
529 class="privatelink" onclick="toggle_private();"
530 >hide private</a>]</span></td>
531 </tr>
532 </table>
533 </td>
534</tr>
535</table>
536<a name="fix_method_name"></a>
537<div>
538<table class="details" border="1" cellpadding="3"
539 cellspacing="0" width="100%" bgcolor="white">
540<tr><td>
541 <table width="100%" cellpadding="0" cellspacing="0" border="0">
542 <tr valign="top"><td>
543 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
544 </h3>
545 </td><td align="right" valign="top"
546 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>&nbsp;
547 </td>
548 </tr></table>
549
550 <pre class="literalblock">
551Fix method names to avoid reserved word conflicts.
552
553Args:
554 name: string, method name.
555
556Returns:
557 The name with a '_' prefixed if the name is a reserved word.
558
559</pre>
560 <dl class="fields">
561 </dl>
562</td></tr></table>
563</div>
564<a name="key2param"></a>
565<div>
566<table class="details" border="1" cellpadding="3"
567 cellspacing="0" width="100%" bgcolor="white">
568<tr><td>
569 <table width="100%" cellpadding="0" cellspacing="0" border="0">
570 <tr valign="top"><td>
571 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
572 </h3>
573 </td><td align="right" valign="top"
574 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
575 </td>
576 </tr></table>
577
578 <pre class="literalblock">
579Converts key names into parameter names.
580
581For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
582
583Args:
584 key: string, the method key name.
585
586Returns:
587 A safe method name based on the key name.
588
589</pre>
590 <dl class="fields">
591 </dl>
592</td></tr></table>
593</div>
594<a name="build"></a>
595<div>
596<table class="details" border="1" cellpadding="3"
597 cellspacing="0" width="100%" bgcolor="white">
598<tr><td>
599 <table width="100%" cellpadding="0" cellspacing="0" border="0">
600 <tr valign="top"><td>
601 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
602 <span class="sig-arg">version</span>,
603 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
604 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default">DISCOVERY_URI</span>,
605 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
606 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]607 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]608 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>,
609 <span class="sig-arg">cache_discovery</span>=<span class="sig-default">True</span>,
610 <span class="sig-arg">cache</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]611 </h3>
612 </td><td align="right" valign="top"
613 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
614 </td>
615 </tr></table>
616
617 <pre class="literalblock">
618Construct a Resource for interacting with an API.
619
620Construct a Resource object for interacting with an API. The serviceName and
621version are the names from the Discovery service.
622
623Args:
624 serviceName: string, name of the service.
625 version: string, the version of the service.
626 http: httplib2.Http, An instance of httplib2.Http or something that acts
627 like it that HTTP requests will be made through.
628 discoveryServiceUrl: string, a URI Template that points to the location of
629 the discovery service. It should have two parameters {api} and
630 {apiVersion} that when filled in produce an absolute URI to the discovery
631 document for that service.
632 developerKey: string, key obtained from
633 https://code.google.com/apis/console.
634 model: googleapiclient.Model, converts to and from the wire format.
635 requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP
636 request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]637 credentials: oauth2client.Credentials, credentials to be used for
638 authentication.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]639 cache_discovery: Boolean, whether or not to cache the discovery doc.
640 cache: googleapiclient.discovery_cache.base.CacheBase, an optional
641 cache object for the discovery documents.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]642
643Returns:
644 A Resource object with methods for interacting with the service.
645
646</pre>
647 <dl class="fields">
648 <dt>Decorators:</dt>
649 <dd><ul class="nomargin-top">
650 <li><code>@positional(2)</code></li>
651 </ul></dd>
652 </dl>
653</td></tr></table>
654</div>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]655<a name="_retrieve_discovery_doc"></a>
656<div class="private">
657<table class="details" border="1" cellpadding="3"
658 cellspacing="0" width="100%" bgcolor="white">
659<tr><td>
660 <table width="100%" cellpadding="0" cellspacing="0" border="0">
661 <tr valign="top"><td>
662 <h3 class="epydoc"><span class="sig"><span class="sig-name">_retrieve_discovery_doc</span>(<span class="sig-arg">url</span>,
663 <span class="sig-arg">http</span>,
664 <span class="sig-arg">cache_discovery</span>,
665 <span class="sig-arg">cache</span>=<span class="sig-default">None</span>)</span>
666 </h3>
667 </td><td align="right" valign="top"
668 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_retrieve_discovery_doc">source&nbsp;code</a></span>&nbsp;
669 </td>
670 </tr></table>
671
672 <pre class="literalblock">
673Retrieves the discovery_doc from cache or the internet.
674
675Args:
676 url: string, the URL of the discovery document.
677 http: httplib2.Http, An instance of httplib2.Http or something that acts
678 like it through which HTTP requests will be made.
679 cache_discovery: Boolean, whether or not to cache the discovery doc.
680 cache: googleapiclient.discovery_cache.base.Cache, an optional cache
681 object for the discovery documents.
682
683Returns:
684 A unicode string representation of the discovery document.
685
686</pre>
687 <dl class="fields">
688 </dl>
689</td></tr></table>
690</div>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]691<a name="build_from_document"></a>
692<div>
693<table class="details" border="1" cellpadding="3"
694 cellspacing="0" width="100%" bgcolor="white">
695<tr><td>
696 <table width="100%" cellpadding="0" cellspacing="0" border="0">
697 <tr valign="top"><td>
698 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
699 <span class="sig-arg">base</span>=<span class="sig-default">None</span>,
700 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
701 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
702 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
703 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]704 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
705 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]706 </h3>
707 </td><td align="right" valign="top"
708 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
709 </td>
710 </tr></table>
711
712 <pre class="literalblock">
713Create a Resource for interacting with an API.
714
715Same as `build()`, but constructs the Resource object from a discovery
716document that is it given, as opposed to retrieving one over HTTP.
717
718Args:
719 service: string or object, the JSON discovery document describing the API.
720 The value passed in may either be the JSON string or the deserialized
721 JSON.
722 base: string, base URI for all HTTP requests, usually the discovery URI.
723 This parameter is no longer used as rootUrl and servicePath are included
724 within the discovery document. (deprecated)
725 future: string, discovery document with future capabilities (deprecated).
726 http: httplib2.Http, An instance of httplib2.Http or something that acts
727 like it that HTTP requests will be made through.
728 developerKey: string, Key for controlling API usage, generated
729 from the API Console.
730 model: Model class instance that serializes and de-serializes requests and
731 responses.
732 requestBuilder: Takes an http request and packages it up to be executed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]733 credentials: object, credentials to be used for authentication.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]734
735Returns:
736 A Resource object with methods for interacting with the service.
737
738</pre>
739 <dl class="fields">
740 <dt>Decorators:</dt>
741 <dd><ul class="nomargin-top">
742 <li><code>@positional(1)</code></li>
743 </ul></dd>
744 </dl>
745</td></tr></table>
746</div>
747<a name="_cast"></a>
748<div class="private">
749<table class="details" border="1" cellpadding="3"
750 cellspacing="0" width="100%" bgcolor="white">
751<tr><td>
752 <table width="100%" cellpadding="0" cellspacing="0" border="0">
753 <tr valign="top"><td>
754 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
755 <span class="sig-arg">schema_type</span>)</span>
756 </h3>
757 </td><td align="right" valign="top"
758 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
759 </td>
760 </tr></table>
761
762 <pre class="literalblock">
763Convert value to a string based on JSON Schema type.
764
765See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
766JSON Schema.
767
768Args:
769 value: any, the value to convert
770 schema_type: string, the type that value should be interpreted as
771
772Returns:
773 A string representation of 'value' based on the schema_type.
774
775</pre>
776 <dl class="fields">
777 </dl>
778</td></tr></table>
779</div>
780<a name="_media_size_to_long"></a>
781<div class="private">
782<table class="details" border="1" cellpadding="3"
783 cellspacing="0" width="100%" bgcolor="white">
784<tr><td>
785 <table width="100%" cellpadding="0" cellspacing="0" border="0">
786 <tr valign="top"><td>
787 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
788 </h3>
789 </td><td align="right" valign="top"
790 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
791 </td>
792 </tr></table>
793
794 <pre class="literalblock">
795Convert a string media size, such as 10GB or 3TB into an integer.
796
797Args:
798 maxSize: string, size as a string, such as 2MB or 7GB.
799
800Returns:
801 The size as an integer value.
802
803</pre>
804 <dl class="fields">
805 </dl>
806</td></tr></table>
807</div>
808<a name="_media_path_url_from_info"></a>
809<div class="private">
810<table class="details" border="1" cellpadding="3"
811 cellspacing="0" width="100%" bgcolor="white">
812<tr><td>
813 <table width="100%" cellpadding="0" cellspacing="0" border="0">
814 <tr valign="top"><td>
815 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_path_url_from_info</span>(<span class="sig-arg">root_desc</span>,
816 <span class="sig-arg">path_url</span>)</span>
817 </h3>
818 </td><td align="right" valign="top"
819 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source&nbsp;code</a></span>&nbsp;
820 </td>
821 </tr></table>
822
823 <pre class="literalblock">
824Creates an absolute media path URL.
825
826Constructed using the API root URI and service path from the discovery
827document and the relative path for the API method.
828
829Args:
830 root_desc: Dictionary; the entire original deserialized discovery document.
831 path_url: String; the relative URL for the API method. Relative to the API
832 root, which is specified in the discovery document.
833
834Returns:
835 String; the absolute URI for media upload for the API method.
836
837</pre>
838 <dl class="fields">
839 </dl>
840</td></tr></table>
841</div>
842<a name="_fix_up_parameters"></a>
843<div class="private">
844<table class="details" border="1" cellpadding="3"
845 cellspacing="0" width="100%" bgcolor="white">
846<tr><td>
847 <table width="100%" cellpadding="0" cellspacing="0" border="0">
848 <tr valign="top"><td>
849 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_parameters</span>(<span class="sig-arg">method_desc</span>,
850 <span class="sig-arg">root_desc</span>,
851 <span class="sig-arg">http_method</span>)</span>
852 </h3>
853 </td><td align="right" valign="top"
854 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source&nbsp;code</a></span>&nbsp;
855 </td>
856 </tr></table>
857
858 <pre class="literalblock">
859Updates parameters of an API method with values specific to this library.
860
861Specifically, adds whatever global parameters are specified by the API to the
862parameters for the individual method. Also adds parameters which don't
863appear in the discovery document, but are available to all discovery based
864APIs (these are listed in STACK_QUERY_PARAMETERS).
865
866SIDE EFFECTS: This updates the parameters dictionary object in the method
867description.
868
869Args:
870 method_desc: Dictionary with metadata describing an API method. Value comes
871 from the dictionary of methods stored in the 'methods' key in the
872 deserialized discovery document.
873 root_desc: Dictionary; the entire original deserialized discovery document.
874 http_method: String; the HTTP method used to call the API method described
875 in method_desc.
876
877Returns:
878 The updated Dictionary stored in the 'parameters' key of the method
879 description dictionary.
880
881</pre>
882 <dl class="fields">
883 </dl>
884</td></tr></table>
885</div>
886<a name="_fix_up_media_upload"></a>
887<div class="private">
888<table class="details" border="1" cellpadding="3"
889 cellspacing="0" width="100%" bgcolor="white">
890<tr><td>
891 <table width="100%" cellpadding="0" cellspacing="0" border="0">
892 <tr valign="top"><td>
893 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_media_upload</span>(<span class="sig-arg">method_desc</span>,
894 <span class="sig-arg">root_desc</span>,
895 <span class="sig-arg">path_url</span>,
896 <span class="sig-arg">parameters</span>)</span>
897 </h3>
898 </td><td align="right" valign="top"
899 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>&nbsp;
900 </td>
901 </tr></table>
902
903 <pre class="literalblock">
904Updates parameters of API by adding 'media_body' if supported by method.
905
906SIDE EFFECTS: If the method supports media upload and has a required body,
907sets body to be optional (required=False) instead. Also, if there is a
908'mediaUpload' in the method description, adds 'media_upload' key to
909parameters.
910
911Args:
912 method_desc: Dictionary with metadata describing an API method. Value comes
913 from the dictionary of methods stored in the 'methods' key in the
914 deserialized discovery document.
915 root_desc: Dictionary; the entire original deserialized discovery document.
916 path_url: String; the relative URL for the API method. Relative to the API
917 root, which is specified in the discovery document.
918 parameters: A dictionary describing method parameters for method described
919 in method_desc.
920
921Returns:
922 Triple (accept, max_size, media_path_url) where:
923 - accept is a list of strings representing what content types are
924 accepted for media upload. Defaults to empty list if not in the
925 discovery document.
926 - max_size is a long representing the max size in bytes allowed for a
927 media upload. Defaults to 0L if not in the discovery document.
928 - media_path_url is a String; the absolute URI for media upload for the
929 API method. Constructed using the API root URI and service path from
930 the discovery document and the relative path for the API method. If
931 media upload is not supported, this is None.
932
933</pre>
934 <dl class="fields">
935 </dl>
936</td></tr></table>
937</div>
938<a name="_fix_up_method_description"></a>
939<div class="private">
940<table class="details" border="1" cellpadding="3"
941 cellspacing="0" width="100%" bgcolor="white">
942<tr><td>
943 <table width="100%" cellpadding="0" cellspacing="0" border="0">
944 <tr valign="top"><td>
945 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_method_description</span>(<span class="sig-arg">method_desc</span>,
946 <span class="sig-arg">root_desc</span>)</span>
947 </h3>
948 </td><td align="right" valign="top"
949 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>&nbsp;
950 </td>
951 </tr></table>
952
953 <pre class="literalblock">
954Updates a method description in a discovery document.
955
956SIDE EFFECTS: Changes the parameters dictionary in the method description with
957extra parameters which are used locally.
958
959Args:
960 method_desc: Dictionary with metadata describing an API method. Value comes
961 from the dictionary of methods stored in the 'methods' key in the
962 deserialized discovery document.
963 root_desc: Dictionary; the entire original deserialized discovery document.
964
965Returns:
966 Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
967 where:
968 - path_url is a String; the relative URL for the API method. Relative to
969 the API root, which is specified in the discovery document.
970 - http_method is a String; the HTTP method used to call the API method
971 described in the method description.
972 - method_id is a String; the name of the RPC method associated with the
973 API method, and is in the method description in the 'id' key.
974 - accept is a list of strings representing what content types are
975 accepted for media upload. Defaults to empty list if not in the
976 discovery document.
977 - max_size is a long representing the max size in bytes allowed for a
978 media upload. Defaults to 0L if not in the discovery document.
979 - media_path_url is a String; the absolute URI for media upload for the
980 API method. Constructed using the API root URI and service path from
981 the discovery document and the relative path for the API method. If
982 media upload is not supported, this is None.
983
984</pre>
985 <dl class="fields">
986 </dl>
987</td></tr></table>
988</div>
989<a name="createMethod"></a>
990<div class="private">
991<table class="details" border="1" cellpadding="3"
992 cellspacing="0" width="100%" bgcolor="white">
993<tr><td>
994 <table width="100%" cellpadding="0" cellspacing="0" border="0">
995 <tr valign="top"><td>
996 <h3 class="epydoc"><span class="sig"><span class="sig-name">createMethod</span>(<span class="sig-arg">methodName</span>,
997 <span class="sig-arg">methodDesc</span>,
998 <span class="sig-arg">rootDesc</span>,
999 <span class="sig-arg">schema</span>)</span>
1000 </h3>
1001 </td><td align="right" valign="top"
1002 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>&nbsp;
1003 </td>
1004 </tr></table>
1005
1006 <pre class="literalblock">
1007Creates a method for attaching to a Resource.
1008
1009Args:
1010 methodName: string, name of the method to use.
1011 methodDesc: object, fragment of deserialized discovery document that
1012 describes the method.
1013 rootDesc: object, the entire deserialized discovery document.
1014 schema: object, mapping of schema names to schema descriptions.
1015
1016</pre>
1017 <dl class="fields">
1018 </dl>
1019</td></tr></table>
1020</div>
1021<a name="createNextMethod"></a>
1022<div class="private">
1023<table class="details" border="1" cellpadding="3"
1024 cellspacing="0" width="100%" bgcolor="white">
1025<tr><td>
1026 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1027 <tr valign="top"><td>
1028 <h3 class="epydoc"><span class="sig"><span class="sig-name">createNextMethod</span>(<span class="sig-arg">methodName</span>)</span>
1029 </h3>
1030 </td><td align="right" valign="top"
1031 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>&nbsp;
1032 </td>
1033 </tr></table>
1034
1035 <pre class="literalblock">
1036Creates any _next methods for attaching to a Resource.
1037
1038The _next methods allow for easy iteration through list() responses.
1039
1040Args:
1041 methodName: string, name of the method to use.
1042
1043</pre>
1044 <dl class="fields">
1045 </dl>
1046</td></tr></table>
1047</div>
1048<br />
1049<!-- ==================== VARIABLES DETAILS ==================== -->
1050<a name="section-VariablesDetails"></a>
1051<table class="details" border="1" cellpadding="3"
1052 cellspacing="0" width="100%" bgcolor="white">
1053<tr bgcolor="#70b0f0" class="table-header">
1054 <td colspan="2" class="table-header">
1055 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1056 <tr valign="top">
1057 <td align="left"><span class="table-header">Variables Details</span></td>
1058 <td align="right" valign="top"
1059 ><span class="options">[<a href="#section-VariablesDetails"
1060 class="privatelink" onclick="toggle_private();"
1061 >hide private</a>]</span></td>
1062 </tr>
1063 </table>
1064 </td>
1065</tr>
1066</table>
1067<a name="DISCOVERY_URI"></a>
1068<div class="private">
1069<table class="details" border="1" cellpadding="3"
1070 cellspacing="0" width="100%" bgcolor="white">
1071<tr><td>
1072 <h3 class="epydoc">DISCOVERY_URI</h3>
1073
1074 <dl class="fields">
1075 </dl>
1076 <dl class="fields">
1077 <dt>Value:</dt>
1078 <dd><table><tr><td><pre class="variable">
1079'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1080st'
1081</pre></td></tr></table>
1082</dd>
1083 </dl>
1084</td></tr></table>
1085</div>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]1086<a name="V1_DISCOVERY_URI"></a>
1087<div class="private">
1088<table class="details" border="1" cellpadding="3"
1089 cellspacing="0" width="100%" bgcolor="white">
1090<tr><td>
1091 <h3 class="epydoc">V1_DISCOVERY_URI</h3>
1092
1093 <dl class="fields">
1094 </dl>
1095 <dl class="fields">
1096 <dt>Value:</dt>
1097 <dd><table><tr><td><pre class="variable">
1098'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1099st'
1100</pre></td></tr></table>
1101</dd>
1102 </dl>
1103</td></tr></table>
1104</div>
1105<a name="V2_DISCOVERY_URI"></a>
1106<div class="private">
1107<table class="details" border="1" cellpadding="3"
1108 cellspacing="0" width="100%" bgcolor="white">
1109<tr><td>
1110 <h3 class="epydoc">V2_DISCOVERY_URI</h3>
1111
1112 <dl class="fields">
1113 </dl>
1114 <dl class="fields">
1115 <dt>Value:</dt>
1116 <dd><table><tr><td><pre class="variable">
1117'https://{api}.googleapis.com/$discovery/rest?' 'version={apiVersion}'
1118</pre></td></tr></table>
1119</dd>
1120 </dl>
1121</td></tr></table>
1122</div>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1123<a name="BODY_PARAMETER_DEFAULT_VALUE"></a>
1124<div class="private">
1125<table class="details" border="1" cellpadding="3"
1126 cellspacing="0" width="100%" bgcolor="white">
1127<tr><td>
1128 <h3 class="epydoc">BODY_PARAMETER_DEFAULT_VALUE</h3>
1129
1130 <dl class="fields">
1131 </dl>
1132 <dl class="fields">
1133 <dt>Value:</dt>
1134 <dd><table><tr><td><pre class="variable">
1135{'description': 'The request body.', 'type': 'object', 'required': Tru<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1136e,}
1137</pre></td></tr></table>
1138</dd>
1139 </dl>
1140</td></tr></table>
1141</div>
1142<a name="MEDIA_BODY_PARAMETER_DEFAULT_VALUE"></a>
1143<div class="private">
1144<table class="details" border="1" cellpadding="3"
1145 cellspacing="0" width="100%" bgcolor="white">
1146<tr><td>
1147 <h3 class="epydoc">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</h3>
1148
1149 <dl class="fields">
1150 </dl>
1151 <dl class="fields">
1152 <dt>Value:</dt>
1153 <dd><table><tr><td><pre class="variable">
1154{'description':('The filename of the media request body, or an instanc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1155e ' 'of a MediaUpload object.'), 'type': 'string', 'required': False,}
1156</pre></td></tr></table>
1157</dd>
1158 </dl>
1159</td></tr></table>
1160</div>
1161<a name="STACK_QUERY_PARAMETERS"></a>
1162<div class="private">
1163<table class="details" border="1" cellpadding="3"
1164 cellspacing="0" width="100%" bgcolor="white">
1165<tr><td>
1166 <h3 class="epydoc">STACK_QUERY_PARAMETERS</h3>
1167
1168 <dl class="fields">
1169 </dl>
1170 <dl class="fields">
1171 <dt>Value:</dt>
1172 <dd><table><tr><td><pre class="variable">
1173frozenset(['trace', 'pp', 'userip', 'strict'])
1174</pre></td></tr></table>
1175</dd>
1176 </dl>
1177</td></tr></table>
1178</div>
1179<a name="STACK_QUERY_PARAMETER_DEFAULT_VALUE"></a>
1180<div class="private">
1181<table class="details" border="1" cellpadding="3"
1182 cellspacing="0" width="100%" bgcolor="white">
1183<tr><td>
1184 <h3 class="epydoc">STACK_QUERY_PARAMETER_DEFAULT_VALUE</h3>
1185
1186 <dl class="fields">
1187 </dl>
1188 <dl class="fields">
1189 <dt>Value:</dt>
1190 <dd><table><tr><td><pre class="variable">
1191{'type': 'string', 'location': 'query'}
1192</pre></td></tr></table>
1193</dd>
1194 </dl>
1195</td></tr></table>
1196</div>
1197<br />
1198<!-- ==================== NAVIGATION BAR ==================== -->
1199<table class="navbar" border="0" width="100%" cellpadding="0"
1200 bgcolor="#a0c0ff" cellspacing="0">
1201 <tr valign="middle">
1202 <!-- Home link -->
1203 <th>&nbsp;&nbsp;&nbsp;<a
1204 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1205
1206 <!-- Tree link -->
1207 <th>&nbsp;&nbsp;&nbsp;<a
1208 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1209
1210 <!-- Index link -->
1211 <th>&nbsp;&nbsp;&nbsp;<a
1212 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1213
1214 <!-- Help link -->
1215 <th>&nbsp;&nbsp;&nbsp;<a
1216 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1217
1218 <th class="navbar" width="100%"></th>
1219 </tr>
1220</table>
1221<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1222 <tr>
1223 <td align="left" class="footer">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]1224 Generated by Epydoc 3.0.1 on Thu May 19 10:53:24 2016
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1225 </td>
1226 <td align="right" class="footer">
1227 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1228 >http://epydoc.sourceforge.net</a>
1229 </td>
1230 </tr>
1231</table>
1232
1233<script type="text/javascript">
1234 <!--
1235 // Private objects are initially displayed (because if
1236 // javascript is turned off then we want them to be
1237 // visible); but by default, we want to hide them. So hide
1238 // them unless we have a cookie that says to show them.
1239 checkCookie();
1240 // -->
1241</script>
1242</body>
1243</html>