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