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