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