Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a8b35b9481ec86d3034367a3248fd0cafab9e3e9 / . / docs / epy / googleapiclient.discovery-module.html
blob: ecf85168715cd0318fc051d2fed2b0b9f8515c8e [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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]59<p>Client for discovery based APIs.</p>
60 <p>A client library for Google's discovery based APIs.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]61
62<hr />
63<div class="fields"> <p><strong>Author:</strong>
64 jcgregorio@google.com (Joe Gregorio)
65 </p>
66</div><!-- ==================== CLASSES ==================== -->
67<a name="section-Classes"></a>
68<table class="summary" border="1" cellpadding="3"
69 cellspacing="0" width="100%" bgcolor="white">
70<tr bgcolor="#70b0f0" class="table-header">
71 <td colspan="2" class="table-header">
72 <table border="0" cellpadding="0" cellspacing="0" width="100%">
73 <tr valign="top">
74 <td align="left"><span class="table-header">Classes</span></td>
75 <td align="right" valign="top"
76 ><span class="options">[<a href="#section-Classes"
77 class="privatelink" onclick="toggle_private();"
78 >hide private</a>]</span></td>
79 </tr>
80 </table>
81 </td>
82</tr>
83<tr class="private">
84 <td width="15%" align="right" valign="top" class="summary">
85 <span class="summary-type">&nbsp;</span>
86 </td><td class="summary">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]87 <a href="googleapiclient.discovery._BytesGenerator-class.html" class="summary-name" onclick="show_private();">_BytesGenerator</a>
88 </td>
89 </tr>
90<tr class="private">
91 <td width="15%" align="right" valign="top" class="summary">
92 <span class="summary-type">&nbsp;</span>
93 </td><td class="summary">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]94 <a href="googleapiclient.discovery.ResourceMethodParameters-class.html" class="summary-name" onclick="show_private();">ResourceMethodParameters</a><br />
95 Represents the parameters associated with a method.
96 </td>
97 </tr>
98<tr class="private">
99 <td width="15%" align="right" valign="top" class="summary">
100 <span class="summary-type">&nbsp;</span>
101 </td><td class="summary">
102 <a href="googleapiclient.discovery.Resource-class.html" class="summary-name" onclick="show_private();">Resource</a><br />
103 A class for interacting with a resource.
104 </td>
105 </tr>
106</table>
107<!-- ==================== FUNCTIONS ==================== -->
108<a name="section-Functions"></a>
109<table class="summary" border="1" cellpadding="3"
110 cellspacing="0" width="100%" bgcolor="white">
111<tr bgcolor="#70b0f0" class="table-header">
112 <td colspan="2" class="table-header">
113 <table border="0" cellpadding="0" cellspacing="0" width="100%">
114 <tr valign="top">
115 <td align="left"><span class="table-header">Functions</span></td>
116 <td align="right" valign="top"
117 ><span class="options">[<a href="#section-Functions"
118 class="privatelink" onclick="toggle_private();"
119 >hide private</a>]</span></td>
120 </tr>
121 </table>
122 </td>
123</tr>
124<tr>
125 <td width="15%" align="right" valign="top" class="summary">
126 <span class="summary-type">&nbsp;</span>
127 </td><td class="summary">
128 <table width="100%" cellpadding="0" cellspacing="0" border="0">
129 <tr>
130 <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]131 Fix method names to avoid '$' characters and reserved word conflicts.</td>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132 <td align="right" valign="top">
133 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>
134
135 </td>
136 </tr>
137 </table>
138
139 </td>
140 </tr>
141<tr>
142 <td width="15%" align="right" valign="top" class="summary">
143 <span class="summary-type">&nbsp;</span>
144 </td><td class="summary">
145 <table width="100%" cellpadding="0" cellspacing="0" border="0">
146 <tr>
147 <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 />
148 Converts key names into parameter names.</td>
149 <td align="right" valign="top">
150 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>
151
152 </td>
153 </tr>
154 </table>
155
156 </td>
157 </tr>
158<tr>
159 <td width="15%" align="right" valign="top" class="summary">
160 <span class="summary-type">&nbsp;</span>
161 </td><td class="summary">
162 <table width="100%" cellpadding="0" cellspacing="0" border="0">
163 <tr>
164 <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>,
165 <span class="summary-sig-arg">version</span>,
166 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
167 <span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default">DISCOVERY_URI</span>,
168 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
169 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]170 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]171 <span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>,
172 <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]173 <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]174 <span class="summary-sig-arg">client_options</span>=<span class="summary-sig-default">None</span>,
175 <span class="summary-sig-arg">adc_cert_path</span>=<span class="summary-sig-default">None</span>,
176 <span class="summary-sig-arg">adc_key_path</span>=<span class="summary-sig-default">None</span>,
177 <span class="summary-sig-arg">num_retries</span>=<span class="summary-sig-default">1</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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]194 <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_discovery_service_uri_options" class="summary-sig-name" onclick="show_private();">_discovery_service_uri_options</a>(<span class="summary-sig-arg">discoveryServiceUrl</span>,
195 <span class="summary-sig-arg">version</span>)</span><br />
196 Returns Discovery URIs to be used for attemnting to build the API Resource.</td>
197 <td align="right" valign="top">
198 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_discovery_service_uri_options">source&nbsp;code</a></span>
199
200 </td>
201 </tr>
202 </table>
203
204 </td>
205 </tr>
206<tr class="private">
207 <td width="15%" align="right" valign="top" class="summary">
208 <span class="summary-type">&nbsp;</span>
209 </td><td class="summary">
210 <table width="100%" cellpadding="0" cellspacing="0" border="0">
211 <tr>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]212 <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>,
213 <span class="summary-sig-arg">http</span>,
214 <span class="summary-sig-arg">cache_discovery</span>,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 <span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]216 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
217 <span class="summary-sig-arg">num_retries</span>=<span class="summary-sig-default">1</span>)</span><br />
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]218 Retrieves the discovery_doc from cache or the internet.</td>
219 <td align="right" valign="top">
220 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_retrieve_discovery_doc">source&nbsp;code</a></span>
221
222 </td>
223 </tr>
224 </table>
225
226 </td>
227 </tr>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]228<tr>
229 <td width="15%" align="right" valign="top" class="summary">
230 <span class="summary-type">&nbsp;</span>
231 </td><td class="summary">
232 <table width="100%" cellpadding="0" cellspacing="0" border="0">
233 <tr>
234 <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>,
235 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>,
236 <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
237 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
238 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
239 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]240 <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]241 <span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]242 <span class="summary-sig-arg">client_options</span>=<span class="summary-sig-default">None</span>,
243 <span class="summary-sig-arg">adc_cert_path</span>=<span class="summary-sig-default">None</span>,
244 <span class="summary-sig-arg">adc_key_path</span>=<span class="summary-sig-default">None</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]245 Create a Resource for interacting with an API.</td>
246 <td align="right" valign="top">
247 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>
248
249 </td>
250 </tr>
251 </table>
252
253 </td>
254 </tr>
255<tr class="private">
256 <td width="15%" align="right" valign="top" class="summary">
257 <span class="summary-type">&nbsp;</span>
258 </td><td class="summary">
259 <table width="100%" cellpadding="0" cellspacing="0" border="0">
260 <tr>
261 <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>,
262 <span class="summary-sig-arg">schema_type</span>)</span><br />
263 Convert value to a string based on JSON Schema type.</td>
264 <td align="right" valign="top">
265 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>
266
267 </td>
268 </tr>
269 </table>
270
271 </td>
272 </tr>
273<tr class="private">
274 <td width="15%" align="right" valign="top" class="summary">
275 <span class="summary-type">&nbsp;</span>
276 </td><td class="summary">
277 <table width="100%" cellpadding="0" cellspacing="0" border="0">
278 <tr>
279 <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 />
280 Convert a string media size, such as 10GB or 3TB into an integer.</td>
281 <td align="right" valign="top">
282 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>
283
284 </td>
285 </tr>
286 </table>
287
288 </td>
289 </tr>
290<tr class="private">
291 <td width="15%" align="right" valign="top" class="summary">
292 <span class="summary-type">&nbsp;</span>
293 </td><td class="summary">
294 <table width="100%" cellpadding="0" cellspacing="0" border="0">
295 <tr>
296 <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>,
297 <span class="summary-sig-arg">path_url</span>)</span><br />
298 Creates an absolute media path URL.</td>
299 <td align="right" valign="top">
300 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">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_parameters" class="summary-sig-name" onclick="show_private();">_fix_up_parameters</a>(<span class="summary-sig-arg">method_desc</span>,
315 <span class="summary-sig-arg">root_desc</span>,
Bu Sun Kim02bae1c2019-06-14 13:33:59 -0700[diff] [blame]316 <span class="summary-sig-arg">http_method</span>,
317 <span class="summary-sig-arg">schema</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]318 Updates parameters of an API method with values specific to this library.</td>
319 <td align="right" valign="top">
320 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">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_media_upload" class="summary-sig-name" onclick="show_private();">_fix_up_media_upload</a>(<span class="summary-sig-arg">method_desc</span>,
335 <span class="summary-sig-arg">root_desc</span>,
336 <span class="summary-sig-arg">path_url</span>,
337 <span class="summary-sig-arg">parameters</span>)</span><br />
Brian J. Watsonf3973572016-11-01 17:03:25 -0700[diff] [blame]338 Adds 'media_body' and 'media_mime_type' parameters if supported by method.</td>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]339 <td align="right" valign="top">
340 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>
341
342 </td>
343 </tr>
344 </table>
345
346 </td>
347 </tr>
348<tr class="private">
349 <td width="15%" align="right" valign="top" class="summary">
350 <span class="summary-type">&nbsp;</span>
351 </td><td class="summary">
352 <table width="100%" cellpadding="0" cellspacing="0" border="0">
353 <tr>
354 <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]355 <span class="summary-sig-arg">root_desc</span>,
356 <span class="summary-sig-arg">schema</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]357 Updates a method description in a discovery document.</td>
358 <td align="right" valign="top">
359 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>
360
361 </td>
362 </tr>
363 </table>
364
365 </td>
366 </tr>
367<tr class="private">
368 <td width="15%" align="right" valign="top" class="summary">
369 <span class="summary-type">&nbsp;</span>
370 </td><td class="summary">
371 <table width="100%" cellpadding="0" cellspacing="0" border="0">
372 <tr>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]373 <td><span class="summary-sig"><a name="_urljoin"></a><span class="summary-sig-name">_urljoin</span>(<span class="summary-sig-arg">base</span>,
374 <span class="summary-sig-arg">url</span>)</span><br />
375 Custom urljoin replacement supporting : before / in url.</td>
376 <td align="right" valign="top">
377 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_urljoin">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>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]391 <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>,
392 <span class="summary-sig-arg">methodDesc</span>,
393 <span class="summary-sig-arg">rootDesc</span>,
394 <span class="summary-sig-arg">schema</span>)</span><br />
395 Creates a method for attaching to a Resource.</td>
396 <td align="right" valign="top">
397 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>
398
399 </td>
400 </tr>
401 </table>
402
403 </td>
404 </tr>
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>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]411 <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]412 <span class="summary-sig-arg">pageTokenName</span>=<span class="summary-sig-default">&quot;pageToken&quot;</span>,
413 <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]414 <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]415 Creates any _next methods for attaching to a Resource.</td>
416 <td align="right" valign="top">
417 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>
418
419 </td>
420 </tr>
421 </table>
422
423 </td>
424 </tr>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]425<tr class="private">
426 <td width="15%" align="right" valign="top" class="summary">
427 <span class="summary-type">&nbsp;</span>
428 </td><td class="summary">
429 <table width="100%" cellpadding="0" cellspacing="0" border="0">
430 <tr>
431 <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 />
432 Search field names for one like a page token.</td>
433 <td align="right" valign="top">
434 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_findPageTokenName">source&nbsp;code</a></span>
435
436 </td>
437 </tr>
438 </table>
439
440 </td>
441 </tr>
442<tr class="private">
443 <td width="15%" align="right" valign="top" class="summary">
444 <span class="summary-type">&nbsp;</span>
445 </td><td class="summary">
446 <table width="100%" cellpadding="0" cellspacing="0" border="0">
447 <tr>
448 <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>,
449 <span class="summary-sig-arg">schema</span>,
450 <span class="summary-sig-arg">name</span>)</span><br />
451 Get properties of a field in a method description.</td>
452 <td align="right" valign="top">
453 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_methodProperties">source&nbsp;code</a></span>
454
455 </td>
456 </tr>
457 </table>
458
459 </td>
460 </tr>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]461</table>
462<!-- ==================== VARIABLES ==================== -->
463<a name="section-Variables"></a>
464<table class="summary" border="1" cellpadding="3"
465 cellspacing="0" width="100%" bgcolor="white">
466<tr bgcolor="#70b0f0" class="table-header">
467 <td colspan="2" class="table-header">
468 <table border="0" cellpadding="0" cellspacing="0" width="100%">
469 <tr valign="top">
470 <td align="left"><span class="table-header">Variables</span></td>
471 <td align="right" valign="top"
472 ><span class="options">[<a href="#section-Variables"
473 class="privatelink" onclick="toggle_private();"
474 >hide private</a>]</span></td>
475 </tr>
476 </table>
477 </td>
478</tr>
479<tr class="private">
480 <td width="15%" align="right" valign="top" class="summary">
481 <span class="summary-type">&nbsp;</span>
482 </td><td class="summary">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]483 <a name="google_auth_httplib2"></a><span class="summary-name">google_auth_httplib2</span> = <code title="None">None</code>
484 </td>
485 </tr>
486<tr class="private">
487 <td width="15%" align="right" valign="top" class="summary">
488 <span class="summary-type">&nbsp;</span>
489 </td><td class="summary">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]490 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]497 <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]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]504 <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]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]511 <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\
512st&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]513 </td>
514 </tr>
515<tr class="private">
516 <td width="15%" align="right" valign="top" class="summary">
517 <span class="summary-type">&nbsp;</span>
518 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]519 <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\
520st&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]521 </td>
522 </tr>
523<tr class="private">
524 <td width="15%" align="right" valign="top" class="summary">
525 <span class="summary-type">&nbsp;</span>
526 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]527 <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]528 </td>
529 </tr>
530<tr class="private">
531 <td width="15%" align="right" valign="top" class="summary">
532 <span class="summary-type">&nbsp;</span>
533 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]534 <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]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]541 <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]542 </td>
543 </tr>
544<tr class="private">
545 <td width="15%" align="right" valign="top" class="summary">
546 <span class="summary-type">&nbsp;</span>
547 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]548 <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]549 </td>
550 </tr>
551<tr class="private">
552 <td width="15%" align="right" valign="top" class="summary">
553 <span class="summary-type">&nbsp;</span>
554 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]555 <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]556 </td>
557 </tr>
558<tr class="private">
559 <td width="15%" align="right" valign="top" class="summary">
560 <span class="summary-type">&nbsp;</span>
561 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]562 <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\
563e &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]564 </td>
565 </tr>
566<tr class="private">
567 <td width="15%" align="right" valign="top" class="summary">
568 <span class="summary-type">&nbsp;</span>
569 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]570 <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\
571ce &quot; &quot;of a MediaUpload object.&quot;), &quot;type&quot;: &quot;string&quot;, &quot;required&quot;: False,\
572}">{&quot;description&quot;:(&quot;The<code class="variable-ellipsis">...</code></code>
Brian J. Watsonf3973572016-11-01 17:03:25 -0700[diff] [blame]573 </td>
574 </tr>
575<tr class="private">
576 <td width="15%" align="right" valign="top" class="summary">
577 <span class="summary-type">&nbsp;</span>
578 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]579 <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]580 </td>
581 </tr>
582<tr class="private">
583 <td width="15%" align="right" valign="top" class="summary">
584 <span class="summary-type">&nbsp;</span>
585 </td><td class="summary">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]586 <a href="googleapiclient.discovery-module.html#GOOGLE_API_USE_CLIENT_CERTIFICATE" class="summary-name" onclick="show_private();">GOOGLE_API_USE_CLIENT_CERTIFICATE</a> = <code title="&quot;GOOGLE_API_USE_CLIENT_CERTIFICATE&quot;">&quot;GOOGLE_API_USE_CLIENT_CER<code class="variable-ellipsis">...</code></code>
587 </td>
588 </tr>
589<tr class="private">
590 <td width="15%" align="right" valign="top" class="summary">
591 <span class="summary-type">&nbsp;</span>
592 </td><td class="summary">
593 <a name="GOOGLE_API_USE_MTLS_ENDPOINT"></a><span class="summary-name">GOOGLE_API_USE_MTLS_ENDPOINT</span> = <code title="&quot;GOOGLE_API_USE_MTLS_ENDPOINT&quot;">&quot;GOOGLE_API_USE_MTLS_ENDPOINT&quot;</code>
594 </td>
595 </tr>
596<tr class="private">
597 <td width="15%" align="right" valign="top" class="summary">
598 <span class="summary-type">&nbsp;</span>
599 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]600 <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]601 </td>
602 </tr>
603<tr class="private">
604 <td width="15%" align="right" valign="top" class="summary">
605 <span class="summary-type">&nbsp;</span>
606 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]607 <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]608 </td>
609 </tr>
610<tr class="private">
611 <td width="15%" align="right" valign="top" class="summary">
612 <span class="summary-type">&nbsp;</span>
613 </td><td class="summary">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]614 <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]615 </td>
616 </tr>
617</table>
618<!-- ==================== FUNCTION DETAILS ==================== -->
619<a name="section-FunctionDetails"></a>
620<table class="details" border="1" cellpadding="3"
621 cellspacing="0" width="100%" bgcolor="white">
622<tr bgcolor="#70b0f0" class="table-header">
623 <td colspan="2" class="table-header">
624 <table border="0" cellpadding="0" cellspacing="0" width="100%">
625 <tr valign="top">
626 <td align="left"><span class="table-header">Function Details</span></td>
627 <td align="right" valign="top"
628 ><span class="options">[<a href="#section-FunctionDetails"
629 class="privatelink" onclick="toggle_private();"
630 >hide private</a>]</span></td>
631 </tr>
632 </table>
633 </td>
634</tr>
635</table>
636<a name="fix_method_name"></a>
637<div>
638<table class="details" border="1" cellpadding="3"
639 cellspacing="0" width="100%" bgcolor="white">
640<tr><td>
641 <table width="100%" cellpadding="0" cellspacing="0" border="0">
642 <tr valign="top"><td>
643 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
644 </h3>
645 </td><td align="right" valign="top"
646 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>&nbsp;
647 </td>
648 </tr></table>
649
650 <pre class="literalblock">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]651Fix method names to avoid '$' characters and reserved word conflicts.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]652
653Args:
654 name: string, method name.
655
656Returns:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]657 The name with '_' appended if the name is a reserved word and '$' and '-'
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]658 replaced with '_'.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]659
660</pre>
661 <dl class="fields">
662 </dl>
663</td></tr></table>
664</div>
665<a name="key2param"></a>
666<div>
667<table class="details" border="1" cellpadding="3"
668 cellspacing="0" width="100%" bgcolor="white">
669<tr><td>
670 <table width="100%" cellpadding="0" cellspacing="0" border="0">
671 <tr valign="top"><td>
672 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
673 </h3>
674 </td><td align="right" valign="top"
675 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
676 </td>
677 </tr></table>
678
679 <pre class="literalblock">
680Converts key names into parameter names.
681
682For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
683
684Args:
685 key: string, the method key name.
686
687Returns:
688 A safe method name based on the key name.
689
690</pre>
691 <dl class="fields">
692 </dl>
693</td></tr></table>
694</div>
695<a name="build"></a>
696<div>
697<table class="details" border="1" cellpadding="3"
698 cellspacing="0" width="100%" bgcolor="white">
699<tr><td>
700 <table width="100%" cellpadding="0" cellspacing="0" border="0">
701 <tr valign="top"><td>
702 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
703 <span class="sig-arg">version</span>,
704 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
705 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default">DISCOVERY_URI</span>,
706 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
707 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]708 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]709 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>,
710 <span class="sig-arg">cache_discovery</span>=<span class="sig-default">True</span>,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]711 <span class="sig-arg">cache</span>=<span class="sig-default">None</span>,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]712 <span class="sig-arg">client_options</span>=<span class="sig-default">None</span>,
713 <span class="sig-arg">adc_cert_path</span>=<span class="sig-default">None</span>,
714 <span class="sig-arg">adc_key_path</span>=<span class="sig-default">None</span>,
715 <span class="sig-arg">num_retries</span>=<span class="sig-default">1</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]716 </h3>
717 </td><td align="right" valign="top"
718 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
719 </td>
720 </tr></table>
721
722 <pre class="literalblock">
723Construct a Resource for interacting with an API.
724
725Construct a Resource object for interacting with an API. The serviceName and
726version are the names from the Discovery service.
727
728Args:
729 serviceName: string, name of the service.
730 version: string, the version of the service.
731 http: httplib2.Http, An instance of httplib2.Http or something that acts
732 like it that HTTP requests will be made through.
733 discoveryServiceUrl: string, a URI Template that points to the location of
734 the discovery service. It should have two parameters {api} and
735 {apiVersion} that when filled in produce an absolute URI to the discovery
736 document for that service.
737 developerKey: string, key obtained from
738 https://code.google.com/apis/console.
739 model: googleapiclient.Model, converts to and from the wire format.
740 requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP
741 request.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]742 credentials: oauth2client.Credentials or
743 google.auth.credentials.Credentials, credentials to be used for
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]744 authentication.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]745 cache_discovery: Boolean, whether or not to cache the discovery doc.
746 cache: googleapiclient.discovery_cache.base.CacheBase, an optional
747 cache object for the discovery documents.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]748 client_options: Mapping object or google.api_core.client_options, client
749 options to set user options on the client.
750 (1) The API endpoint should be set through client_options. If API endpoint
751 is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
752 to control which endpoint to use.
753 (2) client_cert_source is not supported, client cert should be provided using
754 client_encrypted_cert_source instead. In order to use the provided client
755 cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
756 set to `true`.
757 More details on the environment variables are here:
758 https://google.aip.dev/auth/4114
759 adc_cert_path: str, client certificate file path to save the application
760 default client certificate for mTLS. This field is required if you want to
761 use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
762 environment variable must be set to `true` in order to use this field,
763 otherwise this field doesn't nothing.
764 More details on the environment variables are here:
765 https://google.aip.dev/auth/4114
766 adc_key_path: str, client encrypted private key file path to save the
767 application default client encrypted private key for mTLS. This field is
768 required if you want to use the default client certificate.
769 `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
770 `true` in order to use this field, otherwise this field doesn't nothing.
771 More details on the environment variables are here:
772 https://google.aip.dev/auth/4114
773 num_retries: Integer, number of times to retry discovery with
774 randomized exponential backoff in case of intermittent/connection issues.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]775
776Returns:
777 A Resource object with methods for interacting with the service.
778
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]779Raises:
780 google.auth.exceptions.MutualTLSChannelError: if there are any problems
781 setting up mutual TLS channel.
782
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]783</pre>
784 <dl class="fields">
785 <dt>Decorators:</dt>
786 <dd><ul class="nomargin-top">
787 <li><code>@positional(2)</code></li>
788 </ul></dd>
789 </dl>
790</td></tr></table>
791</div>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]792<a name="_discovery_service_uri_options"></a>
793<div class="private">
794<table class="details" border="1" cellpadding="3"
795 cellspacing="0" width="100%" bgcolor="white">
796<tr><td>
797 <table width="100%" cellpadding="0" cellspacing="0" border="0">
798 <tr valign="top"><td>
799 <h3 class="epydoc"><span class="sig"><span class="sig-name">_discovery_service_uri_options</span>(<span class="sig-arg">discoveryServiceUrl</span>,
800 <span class="sig-arg">version</span>)</span>
801 </h3>
802 </td><td align="right" valign="top"
803 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_discovery_service_uri_options">source&nbsp;code</a></span>&nbsp;
804 </td>
805 </tr></table>
806
807 <pre class="literalblock">
808
809 Returns Discovery URIs to be used for attemnting to build the API Resource.
810
811Args:
812 discoveryServiceUrl:
813 string, the Original Discovery Service URL preferred by the customer.
814 version:
815 string, API Version requested
816
817Returns:
818 A list of URIs to be tried for the Service Discovery, in order.
819
820
821</pre>
822 <dl class="fields">
823 </dl>
824</td></tr></table>
825</div>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]826<a name="_retrieve_discovery_doc"></a>
827<div class="private">
828<table class="details" border="1" cellpadding="3"
829 cellspacing="0" width="100%" bgcolor="white">
830<tr><td>
831 <table width="100%" cellpadding="0" cellspacing="0" border="0">
832 <tr valign="top"><td>
833 <h3 class="epydoc"><span class="sig"><span class="sig-name">_retrieve_discovery_doc</span>(<span class="sig-arg">url</span>,
834 <span class="sig-arg">http</span>,
835 <span class="sig-arg">cache_discovery</span>,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]836 <span class="sig-arg">cache</span>=<span class="sig-default">None</span>,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]837 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
838 <span class="sig-arg">num_retries</span>=<span class="sig-default">1</span>)</span>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]839 </h3>
840 </td><td align="right" valign="top"
841 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_retrieve_discovery_doc">source&nbsp;code</a></span>&nbsp;
842 </td>
843 </tr></table>
844
845 <pre class="literalblock">
846Retrieves the discovery_doc from cache or the internet.
847
848Args:
849 url: string, the URL of the discovery document.
850 http: httplib2.Http, An instance of httplib2.Http or something that acts
851 like it through which HTTP requests will be made.
852 cache_discovery: Boolean, whether or not to cache the discovery doc.
853 cache: googleapiclient.discovery_cache.base.Cache, an optional cache
854 object for the discovery documents.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]855 developerKey: string, Key for controlling API usage, generated
856 from the API Console.
857 num_retries: Integer, number of times to retry discovery with
858 randomized exponential backoff in case of intermittent/connection issues.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]859
860Returns:
861 A unicode string representation of the discovery document.
862
863</pre>
864 <dl class="fields">
865 </dl>
866</td></tr></table>
867</div>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]868<a name="build_from_document"></a>
869<div>
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">build_from_document</span>(<span class="sig-arg">service</span>,
876 <span class="sig-arg">base</span>=<span class="sig-default">None</span>,
877 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
878 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
879 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
880 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]881 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]882 <span class="sig-arg">credentials</span>=<span class="sig-default">None</span>,
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]883 <span class="sig-arg">client_options</span>=<span class="sig-default">None</span>,
884 <span class="sig-arg">adc_cert_path</span>=<span class="sig-default">None</span>,
885 <span class="sig-arg">adc_key_path</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]886 </h3>
887 </td><td align="right" valign="top"
888 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
889 </td>
890 </tr></table>
891
892 <pre class="literalblock">
893Create a Resource for interacting with an API.
894
895Same as `build()`, but constructs the Resource object from a discovery
896document that is it given, as opposed to retrieving one over HTTP.
897
898Args:
899 service: string or object, the JSON discovery document describing the API.
900 The value passed in may either be the JSON string or the deserialized
901 JSON.
902 base: string, base URI for all HTTP requests, usually the discovery URI.
903 This parameter is no longer used as rootUrl and servicePath are included
904 within the discovery document. (deprecated)
905 future: string, discovery document with future capabilities (deprecated).
906 http: httplib2.Http, An instance of httplib2.Http or something that acts
907 like it that HTTP requests will be made through.
908 developerKey: string, Key for controlling API usage, generated
909 from the API Console.
910 model: Model class instance that serializes and de-serializes requests and
911 responses.
912 requestBuilder: Takes an http request and packages it up to be executed.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]913 credentials: oauth2client.Credentials or
914 google.auth.credentials.Credentials, credentials to be used for
915 authentication.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]916 client_options: Mapping object or google.api_core.client_options, client
917 options to set user options on the client.
918 (1) The API endpoint should be set through client_options. If API endpoint
919 is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
920 to control which endpoint to use.
921 (2) client_cert_source is not supported, client cert should be provided using
922 client_encrypted_cert_source instead. In order to use the provided client
923 cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
924 set to `true`.
925 More details on the environment variables are here:
926 https://google.aip.dev/auth/4114
927 adc_cert_path: str, client certificate file path to save the application
928 default client certificate for mTLS. This field is required if you want to
929 use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
930 environment variable must be set to `true` in order to use this field,
931 otherwise this field doesn't nothing.
932 More details on the environment variables are here:
933 https://google.aip.dev/auth/4114
934 adc_key_path: str, client encrypted private key file path to save the
935 application default client encrypted private key for mTLS. This field is
936 required if you want to use the default client certificate.
937 `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
938 `true` in order to use this field, otherwise this field doesn't nothing.
939 More details on the environment variables are here:
940 https://google.aip.dev/auth/4114
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]941
942Returns:
943 A Resource object with methods for interacting with the service.
944
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]945Raises:
946 google.auth.exceptions.MutualTLSChannelError: if there are any problems
947 setting up mutual TLS channel.
948
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]949</pre>
950 <dl class="fields">
951 <dt>Decorators:</dt>
952 <dd><ul class="nomargin-top">
953 <li><code>@positional(1)</code></li>
954 </ul></dd>
955 </dl>
956</td></tr></table>
957</div>
958<a name="_cast"></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">_cast</span>(<span class="sig-arg">value</span>,
966 <span class="sig-arg">schema_type</span>)</span>
967 </h3>
968 </td><td align="right" valign="top"
969 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
970 </td>
971 </tr></table>
972
973 <pre class="literalblock">
974Convert value to a string based on JSON Schema type.
975
976See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
977JSON Schema.
978
979Args:
980 value: any, the value to convert
981 schema_type: string, the type that value should be interpreted as
982
983Returns:
984 A string representation of 'value' based on the schema_type.
985
986</pre>
987 <dl class="fields">
988 </dl>
989</td></tr></table>
990</div>
991<a name="_media_size_to_long"></a>
992<div class="private">
993<table class="details" border="1" cellpadding="3"
994 cellspacing="0" width="100%" bgcolor="white">
995<tr><td>
996 <table width="100%" cellpadding="0" cellspacing="0" border="0">
997 <tr valign="top"><td>
998 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
999 </h3>
1000 </td><td align="right" valign="top"
1001 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
1002 </td>
1003 </tr></table>
1004
1005 <pre class="literalblock">
1006Convert a string media size, such as 10GB or 3TB into an integer.
1007
1008Args:
1009 maxSize: string, size as a string, such as 2MB or 7GB.
1010
1011Returns:
1012 The size as an integer value.
1013
1014</pre>
1015 <dl class="fields">
1016 </dl>
1017</td></tr></table>
1018</div>
1019<a name="_media_path_url_from_info"></a>
1020<div class="private">
1021<table class="details" border="1" cellpadding="3"
1022 cellspacing="0" width="100%" bgcolor="white">
1023<tr><td>
1024 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1025 <tr valign="top"><td>
1026 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_path_url_from_info</span>(<span class="sig-arg">root_desc</span>,
1027 <span class="sig-arg">path_url</span>)</span>
1028 </h3>
1029 </td><td align="right" valign="top"
1030 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_media_path_url_from_info">source&nbsp;code</a></span>&nbsp;
1031 </td>
1032 </tr></table>
1033
1034 <pre class="literalblock">
1035Creates an absolute media path URL.
1036
1037Constructed using the API root URI and service path from the discovery
1038document and the relative path for the API method.
1039
1040Args:
1041 root_desc: Dictionary; the entire original deserialized discovery document.
1042 path_url: String; the relative URL for the API method. Relative to the API
1043 root, which is specified in the discovery document.
1044
1045Returns:
1046 String; the absolute URI for media upload for the API method.
1047
1048</pre>
1049 <dl class="fields">
1050 </dl>
1051</td></tr></table>
1052</div>
1053<a name="_fix_up_parameters"></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">_fix_up_parameters</span>(<span class="sig-arg">method_desc</span>,
1061 <span class="sig-arg">root_desc</span>,
Bu Sun Kim02bae1c2019-06-14 13:33:59 -0700[diff] [blame]1062 <span class="sig-arg">http_method</span>,
1063 <span class="sig-arg">schema</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1064 </h3>
1065 </td><td align="right" valign="top"
1066 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_parameters">source&nbsp;code</a></span>&nbsp;
1067 </td>
1068 </tr></table>
1069
1070 <pre class="literalblock">
1071Updates parameters of an API method with values specific to this library.
1072
1073Specifically, adds whatever global parameters are specified by the API to the
1074parameters for the individual method. Also adds parameters which don't
1075appear in the discovery document, but are available to all discovery based
1076APIs (these are listed in STACK_QUERY_PARAMETERS).
1077
1078SIDE EFFECTS: This updates the parameters dictionary object in the method
1079description.
1080
1081Args:
1082 method_desc: Dictionary with metadata describing an API method. Value comes
1083 from the dictionary of methods stored in the 'methods' key in the
1084 deserialized discovery document.
1085 root_desc: Dictionary; the entire original deserialized discovery document.
1086 http_method: String; the HTTP method used to call the API method described
1087 in method_desc.
Bu Sun Kim02bae1c2019-06-14 13:33:59 -0700[diff] [blame]1088 schema: Object, mapping of schema names to schema descriptions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1089
1090Returns:
1091 The updated Dictionary stored in the 'parameters' key of the method
1092 description dictionary.
1093
1094</pre>
1095 <dl class="fields">
1096 </dl>
1097</td></tr></table>
1098</div>
1099<a name="_fix_up_media_upload"></a>
1100<div class="private">
1101<table class="details" border="1" cellpadding="3"
1102 cellspacing="0" width="100%" bgcolor="white">
1103<tr><td>
1104 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1105 <tr valign="top"><td>
1106 <h3 class="epydoc"><span class="sig"><span class="sig-name">_fix_up_media_upload</span>(<span class="sig-arg">method_desc</span>,
1107 <span class="sig-arg">root_desc</span>,
1108 <span class="sig-arg">path_url</span>,
1109 <span class="sig-arg">parameters</span>)</span>
1110 </h3>
1111 </td><td align="right" valign="top"
1112 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_media_upload">source&nbsp;code</a></span>&nbsp;
1113 </td>
1114 </tr></table>
1115
1116 <pre class="literalblock">
Brian J. Watsonf3973572016-11-01 17:03:25 -0700[diff] [blame]1117Adds 'media_body' and 'media_mime_type' parameters if supported by method.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1118
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1119SIDE EFFECTS: If there is a 'mediaUpload' in the method description, adds
1120'media_upload' key to parameters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1121
1122Args:
1123 method_desc: Dictionary with metadata describing an API method. Value comes
1124 from the dictionary of methods stored in the 'methods' key in the
1125 deserialized discovery document.
1126 root_desc: Dictionary; the entire original deserialized discovery document.
1127 path_url: String; the relative URL for the API method. Relative to the API
1128 root, which is specified in the discovery document.
1129 parameters: A dictionary describing method parameters for method described
1130 in method_desc.
1131
1132Returns:
1133 Triple (accept, max_size, media_path_url) where:
1134 - accept is a list of strings representing what content types are
1135 accepted for media upload. Defaults to empty list if not in the
1136 discovery document.
1137 - max_size is a long representing the max size in bytes allowed for a
1138 media upload. Defaults to 0L if not in the discovery document.
1139 - media_path_url is a String; the absolute URI for media upload for the
1140 API method. Constructed using the API root URI and service path from
1141 the discovery document and the relative path for the API method. If
1142 media upload is not supported, this is None.
1143
1144</pre>
1145 <dl class="fields">
1146 </dl>
1147</td></tr></table>
1148</div>
1149<a name="_fix_up_method_description"></a>
1150<div class="private">
1151<table class="details" border="1" cellpadding="3"
1152 cellspacing="0" width="100%" bgcolor="white">
1153<tr><td>
1154 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1155 <tr valign="top"><td>
1156 <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]1157 <span class="sig-arg">root_desc</span>,
1158 <span class="sig-arg">schema</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1159 </h3>
1160 </td><td align="right" valign="top"
1161 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_fix_up_method_description">source&nbsp;code</a></span>&nbsp;
1162 </td>
1163 </tr></table>
1164
1165 <pre class="literalblock">
1166Updates a method description in a discovery document.
1167
1168SIDE EFFECTS: Changes the parameters dictionary in the method description with
1169extra parameters which are used locally.
1170
1171Args:
1172 method_desc: Dictionary with metadata describing an API method. Value comes
1173 from the dictionary of methods stored in the 'methods' key in the
1174 deserialized discovery document.
1175 root_desc: Dictionary; the entire original deserialized discovery document.
Bu Sun Kim02bae1c2019-06-14 13:33:59 -0700[diff] [blame]1176 schema: Object, mapping of schema names to schema descriptions.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1177
1178Returns:
1179 Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
1180 where:
1181 - path_url is a String; the relative URL for the API method. Relative to
1182 the API root, which is specified in the discovery document.
1183 - http_method is a String; the HTTP method used to call the API method
1184 described in the method description.
1185 - method_id is a String; the name of the RPC method associated with the
1186 API method, and is in the method description in the 'id' key.
1187 - accept is a list of strings representing what content types are
1188 accepted for media upload. Defaults to empty list if not in the
1189 discovery document.
1190 - max_size is a long representing the max size in bytes allowed for a
1191 media upload. Defaults to 0L if not in the discovery document.
1192 - media_path_url is a String; the absolute URI for media upload for the
1193 API method. Constructed using the API root URI and service path from
1194 the discovery document and the relative path for the API method. If
1195 media upload is not supported, this is None.
1196
1197</pre>
1198 <dl class="fields">
1199 </dl>
1200</td></tr></table>
1201</div>
1202<a name="createMethod"></a>
1203<div class="private">
1204<table class="details" border="1" cellpadding="3"
1205 cellspacing="0" width="100%" bgcolor="white">
1206<tr><td>
1207 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1208 <tr valign="top"><td>
1209 <h3 class="epydoc"><span class="sig"><span class="sig-name">createMethod</span>(<span class="sig-arg">methodName</span>,
1210 <span class="sig-arg">methodDesc</span>,
1211 <span class="sig-arg">rootDesc</span>,
1212 <span class="sig-arg">schema</span>)</span>
1213 </h3>
1214 </td><td align="right" valign="top"
1215 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createMethod">source&nbsp;code</a></span>&nbsp;
1216 </td>
1217 </tr></table>
1218
1219 <pre class="literalblock">
1220Creates a method for attaching to a Resource.
1221
1222Args:
1223 methodName: string, name of the method to use.
1224 methodDesc: object, fragment of deserialized discovery document that
1225 describes the method.
1226 rootDesc: object, the entire deserialized discovery document.
1227 schema: object, mapping of schema names to schema descriptions.
1228
1229</pre>
1230 <dl class="fields">
1231 </dl>
1232</td></tr></table>
1233</div>
1234<a name="createNextMethod"></a>
1235<div class="private">
1236<table class="details" border="1" cellpadding="3"
1237 cellspacing="0" width="100%" bgcolor="white">
1238<tr><td>
1239 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1240 <tr valign="top"><td>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1241 <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]1242 <span class="sig-arg">pageTokenName</span>=<span class="sig-default">&quot;pageToken&quot;</span>,
1243 <span class="sig-arg">nextPageTokenName</span>=<span class="sig-default">&quot;nextPageToken&quot;</span>,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1244 <span class="sig-arg">isPageTokenParameter</span>=<span class="sig-default">True</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1245 </h3>
1246 </td><td align="right" valign="top"
1247 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#createNextMethod">source&nbsp;code</a></span>&nbsp;
1248 </td>
1249 </tr></table>
1250
1251 <pre class="literalblock">
1252Creates any _next methods for attaching to a Resource.
1253
1254The _next methods allow for easy iteration through list() responses.
1255
1256Args:
1257 methodName: string, name of the method to use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1258 pageTokenName: string, name of request page token field.
1259 nextPageTokenName: string, name of response page token field.
1260 isPageTokenParameter: Boolean, True if request page token is a query
1261 parameter, False if request page token is a field of the request body.
1262
1263</pre>
1264 <dl class="fields">
1265 </dl>
1266</td></tr></table>
1267</div>
1268<a name="_findPageTokenName"></a>
1269<div class="private">
1270<table class="details" border="1" cellpadding="3"
1271 cellspacing="0" width="100%" bgcolor="white">
1272<tr><td>
1273 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1274 <tr valign="top"><td>
1275 <h3 class="epydoc"><span class="sig"><span class="sig-name">_findPageTokenName</span>(<span class="sig-arg">fields</span>)</span>
1276 </h3>
1277 </td><td align="right" valign="top"
1278 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_findPageTokenName">source&nbsp;code</a></span>&nbsp;
1279 </td>
1280 </tr></table>
1281
1282 <pre class="literalblock">
1283Search field names for one like a page token.
1284
1285Args:
1286 fields: container of string, names of fields.
1287
1288Returns:
1289 First name that is either 'pageToken' or 'nextPageToken' if one exists,
1290 otherwise None.
1291
1292</pre>
1293 <dl class="fields">
1294 </dl>
1295</td></tr></table>
1296</div>
1297<a name="_methodProperties"></a>
1298<div class="private">
1299<table class="details" border="1" cellpadding="3"
1300 cellspacing="0" width="100%" bgcolor="white">
1301<tr><td>
1302 <table width="100%" cellpadding="0" cellspacing="0" border="0">
1303 <tr valign="top"><td>
1304 <h3 class="epydoc"><span class="sig"><span class="sig-name">_methodProperties</span>(<span class="sig-arg">methodDesc</span>,
1305 <span class="sig-arg">schema</span>,
1306 <span class="sig-arg">name</span>)</span>
1307 </h3>
1308 </td><td align="right" valign="top"
1309 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_methodProperties">source&nbsp;code</a></span>&nbsp;
1310 </td>
1311 </tr></table>
1312
1313 <pre class="literalblock">
1314Get properties of a field in a method description.
1315
1316Args:
1317 methodDesc: object, fragment of deserialized discovery document that
1318 describes the method.
1319 schema: object, mapping of schema names to schema descriptions.
1320 name: string, name of top-level field in method description.
1321
1322Returns:
1323 Object representing fragment of deserialized discovery document
1324 corresponding to 'properties' field of object corresponding to named field
1325 in method description, if it exists, otherwise empty dict.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1326
1327</pre>
1328 <dl class="fields">
1329 </dl>
1330</td></tr></table>
1331</div>
1332<br />
1333<!-- ==================== VARIABLES DETAILS ==================== -->
1334<a name="section-VariablesDetails"></a>
1335<table class="details" border="1" cellpadding="3"
1336 cellspacing="0" width="100%" bgcolor="white">
1337<tr bgcolor="#70b0f0" class="table-header">
1338 <td colspan="2" class="table-header">
1339 <table border="0" cellpadding="0" cellspacing="0" width="100%">
1340 <tr valign="top">
1341 <td align="left"><span class="table-header">Variables Details</span></td>
1342 <td align="right" valign="top"
1343 ><span class="options">[<a href="#section-VariablesDetails"
1344 class="privatelink" onclick="toggle_private();"
1345 >hide private</a>]</span></td>
1346 </tr>
1347 </table>
1348 </td>
1349</tr>
1350</table>
1351<a name="DISCOVERY_URI"></a>
1352<div class="private">
1353<table class="details" border="1" cellpadding="3"
1354 cellspacing="0" width="100%" bgcolor="white">
1355<tr><td>
1356 <h3 class="epydoc">DISCOVERY_URI</h3>
1357
1358 <dl class="fields">
1359 </dl>
1360 <dl class="fields">
1361 <dt>Value:</dt>
1362 <dd><table><tr><td><pre class="variable">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1363&quot;https://www.googleapis.com/discovery/v1/apis/&quot; &quot;{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1364st&quot;
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1365</pre></td></tr></table>
1366</dd>
1367 </dl>
1368</td></tr></table>
1369</div>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1370<a name="V1_DISCOVERY_URI"></a>
1371<div class="private">
1372<table class="details" border="1" cellpadding="3"
1373 cellspacing="0" width="100%" bgcolor="white">
1374<tr><td>
1375 <h3 class="epydoc">V1_DISCOVERY_URI</h3>
1376
1377 <dl class="fields">
1378 </dl>
1379 <dl class="fields">
1380 <dt>Value:</dt>
1381 <dd><table><tr><td><pre class="variable">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1382&quot;https://www.googleapis.com/discovery/v1/apis/&quot; &quot;{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1383st&quot;
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1384</pre></td></tr></table>
1385</dd>
1386 </dl>
1387</td></tr></table>
1388</div>
1389<a name="V2_DISCOVERY_URI"></a>
1390<div class="private">
1391<table class="details" border="1" cellpadding="3"
1392 cellspacing="0" width="100%" bgcolor="white">
1393<tr><td>
1394 <h3 class="epydoc">V2_DISCOVERY_URI</h3>
1395
1396 <dl class="fields">
1397 </dl>
1398 <dl class="fields">
1399 <dt>Value:</dt>
1400 <dd><table><tr><td><pre class="variable">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1401&quot;https://{api}.googleapis.com/$discovery/rest?&quot; &quot;version={apiVersion}&quot;
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]1402</pre></td></tr></table>
1403</dd>
1404 </dl>
1405</td></tr></table>
1406</div>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1407<a name="BODY_PARAMETER_DEFAULT_VALUE"></a>
1408<div class="private">
1409<table class="details" border="1" cellpadding="3"
1410 cellspacing="0" width="100%" bgcolor="white">
1411<tr><td>
1412 <h3 class="epydoc">BODY_PARAMETER_DEFAULT_VALUE</h3>
1413
1414 <dl class="fields">
1415 </dl>
1416 <dl class="fields">
1417 <dt>Value:</dt>
1418 <dd><table><tr><td><pre class="variable">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1419{&quot;description&quot;: &quot;The request body.&quot;, &quot;type&quot;: &quot;object&quot;}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1420</pre></td></tr></table>
1421</dd>
1422 </dl>
1423</td></tr></table>
1424</div>
1425<a name="MEDIA_BODY_PARAMETER_DEFAULT_VALUE"></a>
1426<div class="private">
1427<table class="details" border="1" cellpadding="3"
1428 cellspacing="0" width="100%" bgcolor="white">
1429<tr><td>
1430 <h3 class="epydoc">MEDIA_BODY_PARAMETER_DEFAULT_VALUE</h3>
1431
1432 <dl class="fields">
1433 </dl>
1434 <dl class="fields">
1435 <dt>Value:</dt>
1436 <dd><table><tr><td><pre class="variable">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1437{&quot;description&quot;:(&quot;The filename of the media request body, or an instanc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
1438e &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]1439</pre></td></tr></table>
1440</dd>
1441 </dl>
1442</td></tr></table>
1443</div>
Brian J. Watsonf3973572016-11-01 17:03:25 -0700[diff] [blame]1444<a name="MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE"></a>
1445<div class="private">
1446<table class="details" border="1" cellpadding="3"
1447 cellspacing="0" width="100%" bgcolor="white">
1448<tr><td>
1449 <h3 class="epydoc">MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE</h3>
1450
1451 <dl class="fields">
1452 </dl>
1453 <dl class="fields">
1454 <dt>Value:</dt>
1455 <dd><table><tr><td><pre class="variable">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1456{&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>
1457ce &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]1458}
1459</pre></td></tr></table>
1460</dd>
1461 </dl>
1462</td></tr></table>
1463</div>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1464<a name="GOOGLE_API_USE_CLIENT_CERTIFICATE"></a>
1465<div class="private">
1466<table class="details" border="1" cellpadding="3"
1467 cellspacing="0" width="100%" bgcolor="white">
1468<tr><td>
1469 <h3 class="epydoc">GOOGLE_API_USE_CLIENT_CERTIFICATE</h3>
1470
1471 <dl class="fields">
1472 </dl>
1473 <dl class="fields">
1474 <dt>Value:</dt>
1475 <dd><table><tr><td><pre class="variable">
1476&quot;GOOGLE_API_USE_CLIENT_CERTIFICATE&quot;
1477</pre></td></tr></table>
1478</dd>
1479 </dl>
1480</td></tr></table>
1481</div>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1482<a name="STACK_QUERY_PARAMETERS"></a>
1483<div class="private">
1484<table class="details" border="1" cellpadding="3"
1485 cellspacing="0" width="100%" bgcolor="white">
1486<tr><td>
1487 <h3 class="epydoc">STACK_QUERY_PARAMETERS</h3>
1488
1489 <dl class="fields">
1490 </dl>
1491 <dl class="fields">
1492 <dt>Value:</dt>
1493 <dd><table><tr><td><pre class="variable">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1494frozenset([&quot;trace&quot;, &quot;pp&quot;, &quot;userip&quot;, &quot;strict&quot;])
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1495</pre></td></tr></table>
1496</dd>
1497 </dl>
1498</td></tr></table>
1499</div>
1500<a name="STACK_QUERY_PARAMETER_DEFAULT_VALUE"></a>
1501<div class="private">
1502<table class="details" border="1" cellpadding="3"
1503 cellspacing="0" width="100%" bgcolor="white">
1504<tr><td>
1505 <h3 class="epydoc">STACK_QUERY_PARAMETER_DEFAULT_VALUE</h3>
1506
1507 <dl class="fields">
1508 </dl>
1509 <dl class="fields">
1510 <dt>Value:</dt>
1511 <dd><table><tr><td><pre class="variable">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]1512{&quot;type&quot;: &quot;string&quot;, &quot;location&quot;: &quot;query&quot;}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1513</pre></td></tr></table>
1514</dd>
1515 </dl>
1516</td></tr></table>
1517</div>
1518<br />
1519<!-- ==================== NAVIGATION BAR ==================== -->
1520<table class="navbar" border="0" width="100%" cellpadding="0"
1521 bgcolor="#a0c0ff" cellspacing="0">
1522 <tr valign="middle">
1523 <!-- Home link -->
1524 <th>&nbsp;&nbsp;&nbsp;<a
1525 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
1526
1527 <!-- Tree link -->
1528 <th>&nbsp;&nbsp;&nbsp;<a
1529 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
1530
1531 <!-- Index link -->
1532 <th>&nbsp;&nbsp;&nbsp;<a
1533 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
1534
1535 <!-- Help link -->
1536 <th>&nbsp;&nbsp;&nbsp;<a
1537 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
1538
1539 <th class="navbar" width="100%"></th>
1540 </tr>
1541</table>
1542<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1543 <tr>
1544 <td align="left" class="footer">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]1545 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1546 </td>
1547 <td align="right" class="footer">
1548 <a target="mainFrame" href="http://epydoc.sourceforge.net"
1549 >http://epydoc.sourceforge.net</a>
1550 </td>
1551 </tr>
1552</table>
1553
1554<script type="text/javascript">
1555 <!--
1556 // Private objects are initially displayed (because if
1557 // javascript is turned off then we want them to be
1558 // visible); but by default, we want to hide them. So hide
1559 // them unless we have a cookie that says to show them.
1560 checkCookie();
1561 // -->
1562</script>
1563</body>
1564</html>