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