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