blob: 41a97dc50a231b1d4ea8934176ec2de9bb28aa7a [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -04001<?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>apiclient.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
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="apiclient-module.html">Package&nbsp;apiclient</a> ::
38 Module&nbsp;discovery
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="apiclient.discovery-module.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<!-- ==================== MODULE DESCRIPTION ==================== -->
55<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.discovery-pysrc.html">source&nbsp;code</a></span></p>
56<pre class="literalblock">
57Client for discovery based APIs
58
59A client library for Google's discovery based APIs.
60
61</pre>
62
63<hr />
64<div class="fields"> <p><strong>Author:</strong>
65 jcgregorio@google.com (Joe Gregorio)
66 </p>
67</div><!-- ==================== FUNCTIONS ==================== -->
68<a name="section-Functions"></a>
69<table class="summary" border="1" cellpadding="3"
70 cellspacing="0" width="100%" bgcolor="white">
71<tr bgcolor="#70b0f0" class="table-header">
72 <td colspan="2" class="table-header">
73 <table border="0" cellpadding="0" cellspacing="0" width="100%">
74 <tr valign="top">
75 <td align="left"><span class="table-header">Functions</span></td>
76 <td align="right" valign="top"
77 ><span class="options">[<a href="#section-Functions"
78 class="privatelink" onclick="toggle_private();"
79 >hide private</a>]</span></td>
80 </tr>
81 </table>
82 </td>
83</tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -040084<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040085 <td width="15%" align="right" valign="top" class="summary">
86 <span class="summary-type">&nbsp;</span>
87 </td><td class="summary">
88 <table width="100%" cellpadding="0" cellspacing="0" border="0">
89 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -040090 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#fix_method_name" class="summary-sig-name">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br />
Joe Gregorio66212032012-06-14 09:10:14 -040091 Fix method names to avoid reserved word conflicts.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040092 <td align="right" valign="top">
Joe Gregorio66212032012-06-14 09:10:14 -040093 <span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -040094
95 </td>
96 </tr>
97 </table>
98
99 </td>
100 </tr>
101<tr class="private">
102 <td width="15%" align="right" valign="top" class="summary">
103 <span class="summary-type">&nbsp;</span>
104 </td><td class="summary">
105 <table width="100%" cellpadding="0" cellspacing="0" border="0">
106 <tr>
107 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_add_query_parameter" class="summary-sig-name" onclick="show_private();">_add_query_parameter</a>(<span class="summary-sig-arg">url</span>,
108 <span class="summary-sig-arg">name</span>,
109 <span class="summary-sig-arg">value</span>)</span><br />
110 Adds a query parameter to a url.</td>
111 <td align="right" valign="top">
112 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source&nbsp;code</a></span>
113
114 </td>
115 </tr>
116 </table>
117
118 </td>
119 </tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400120<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400121 <td width="15%" align="right" valign="top" class="summary">
122 <span class="summary-type">&nbsp;</span>
123 </td><td class="summary">
124 <table width="100%" cellpadding="0" cellspacing="0" border="0">
125 <tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400126 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#key2param" class="summary-sig-name">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400127 Converts key names into parameter names.</td>
128 <td align="right" valign="top">
129 <span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>
130
131 </td>
132 </tr>
133 </table>
134
135 </td>
136 </tr>
137<tr>
138 <td width="15%" align="right" valign="top" class="summary">
139 <span class="summary-type">&nbsp;</span>
140 </td><td class="summary">
141 <table width="100%" cellpadding="0" cellspacing="0" border="0">
142 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400143 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build" class="summary-sig-name">build</a>(<span class="summary-sig-arg">serviceName</span>,
144 <span class="summary-sig-arg">version</span>,
145 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
146 <span class="summary-sig-arg">discoveryServiceUrl</span>=<span class="summary-sig-default">DISCOVERY_URI</span>,
147 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
148 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
149 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400150 Construct a Resource for interacting with an API.</td>
151 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400152 <span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>
153
154 </td>
155 </tr>
156 </table>
157
158 </td>
159 </tr>
160<tr>
161 <td width="15%" align="right" valign="top" class="summary">
162 <span class="summary-type">&nbsp;</span>
163 </td><td class="summary">
164 <table width="100%" cellpadding="0" cellspacing="0" border="0">
165 <tr>
166 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build_from_document" class="summary-sig-name">build_from_document</a>(<span class="summary-sig-arg">service</span>,
167 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>,
168 <span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
169 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
170 <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
171 <span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
172 <span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>)</span><br />
173 Create a Resource for interacting with an API.</td>
174 <td align="right" valign="top">
175 <span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400176
177 </td>
178 </tr>
179 </table>
180
181 </td>
182 </tr>
183<tr class="private">
184 <td width="15%" align="right" valign="top" class="summary">
185 <span class="summary-type">&nbsp;</span>
186 </td><td class="summary">
187 <table width="100%" cellpadding="0" cellspacing="0" border="0">
188 <tr>
189 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_cast" class="summary-sig-name" onclick="show_private();">_cast</a>(<span class="summary-sig-arg">value</span>,
190 <span class="summary-sig-arg">schema_type</span>)</span><br />
191 Convert value to a string based on JSON Schema type.</td>
192 <td align="right" valign="top">
193 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>
194
195 </td>
196 </tr>
197 </table>
198
199 </td>
200 </tr>
201<tr class="private">
202 <td width="15%" align="right" valign="top" class="summary">
203 <span class="summary-type">&nbsp;</span>
204 </td><td class="summary">
205 <table width="100%" cellpadding="0" cellspacing="0" border="0">
206 <tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400207 <td><span class="summary-sig"><a href="apiclient.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 />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400208 Convert a string media size, such as 10GB or 3TB into an integer.</td>
209 <td align="right" valign="top">
210 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>
211
212 </td>
213 </tr>
214 </table>
215
216 </td>
217 </tr>
218<tr class="private">
219 <td width="15%" align="right" valign="top" class="summary">
220 <span class="summary-type">&nbsp;</span>
221 </td><td class="summary">
222 <table width="100%" cellpadding="0" cellspacing="0" border="0">
223 <tr>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400224 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_createResource" class="summary-sig-name" onclick="show_private();">_createResource</a>(<span class="summary-sig-arg">http</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400225 <span class="summary-sig-arg">baseUrl</span>,
226 <span class="summary-sig-arg">model</span>,
227 <span class="summary-sig-arg">requestBuilder</span>,
228 <span class="summary-sig-arg">developerKey</span>,
229 <span class="summary-sig-arg">resourceDesc</span>,
Joe Gregorio66212032012-06-14 09:10:14 -0400230 <span class="summary-sig-arg">rootDesc</span>,
231 <span class="summary-sig-arg">schema</span>)</span><br />
232 Build a Resource from the API description.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400233 <td align="right" valign="top">
Joe Gregorioebd0b842012-06-15 14:14:17 -0400234 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_createResource">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400235
236 </td>
237 </tr>
238 </table>
239
240 </td>
241 </tr>
242</table>
243<!-- ==================== VARIABLES ==================== -->
244<a name="section-Variables"></a>
245<table class="summary" border="1" cellpadding="3"
246 cellspacing="0" width="100%" bgcolor="white">
247<tr bgcolor="#70b0f0" class="table-header">
248 <td colspan="2" class="table-header">
249 <table border="0" cellpadding="0" cellspacing="0" width="100%">
250 <tr valign="top">
251 <td align="left"><span class="table-header">Variables</span></td>
252 <td align="right" valign="top"
253 ><span class="options">[<a href="#section-Variables"
254 class="privatelink" onclick="toggle_private();"
255 >hide private</a>]</span></td>
256 </tr>
257 </table>
258 </td>
259</tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400260<tr>
261 <td width="15%" align="right" valign="top" class="summary">
262 <span class="summary-type">&nbsp;</span>
263 </td><td class="summary">
264 <a name="copy"></a><span class="summary-name">copy</span>
265 </td>
266 </tr>
267<tr>
268 <td width="15%" align="right" valign="top" class="summary">
269 <span class="summary-type">&nbsp;</span>
270 </td><td class="summary">
271 <a name="httplib2"></a><span class="summary-name">httplib2</span>
272 </td>
273 </tr>
274<tr>
275 <td width="15%" align="right" valign="top" class="summary">
276 <span class="summary-type">&nbsp;</span>
277 </td><td class="summary">
278 <a name="logging"></a><span class="summary-name">logging</span>
279 </td>
280 </tr>
281<tr>
282 <td width="15%" align="right" valign="top" class="summary">
283 <span class="summary-type">&nbsp;</span>
284 </td><td class="summary">
285 <a name="os"></a><span class="summary-name">os</span>
286 </td>
287 </tr>
288<tr>
289 <td width="15%" align="right" valign="top" class="summary">
290 <span class="summary-type">&nbsp;</span>
291 </td><td class="summary">
292 <a name="random"></a><span class="summary-name">random</span>
293 </td>
294 </tr>
295<tr>
296 <td width="15%" align="right" valign="top" class="summary">
297 <span class="summary-type">&nbsp;</span>
298 </td><td class="summary">
299 <a name="re"></a><span class="summary-name">re</span>
300 </td>
301 </tr>
302<tr>
303 <td width="15%" align="right" valign="top" class="summary">
304 <span class="summary-type">&nbsp;</span>
305 </td><td class="summary">
306 <a name="uritemplate"></a><span class="summary-name">uritemplate</span>
307 </td>
308 </tr>
309<tr>
310 <td width="15%" align="right" valign="top" class="summary">
311 <span class="summary-type">&nbsp;</span>
312 </td><td class="summary">
313 <a name="urllib"></a><span class="summary-name">urllib</span>
314 </td>
315 </tr>
316<tr>
317 <td width="15%" align="right" valign="top" class="summary">
318 <span class="summary-type">&nbsp;</span>
319 </td><td class="summary">
320 <a name="urlparse"></a><span class="summary-name">urlparse</span>
321 </td>
322 </tr>
323<tr>
324 <td width="15%" align="right" valign="top" class="summary">
325 <span class="summary-type">&nbsp;</span>
326 </td><td class="summary">
327 <a name="mimeparse"></a><span class="summary-name">mimeparse</span>
328 </td>
329 </tr>
330<tr>
331 <td width="15%" align="right" valign="top" class="summary">
332 <span class="summary-type">&nbsp;</span>
333 </td><td class="summary">
334 <a name="mimetypes"></a><span class="summary-name">mimetypes</span>
335 </td>
336 </tr>
337<tr>
338 <td width="15%" align="right" valign="top" class="summary">
339 <span class="summary-type">&nbsp;</span>
340 </td><td class="summary">
341 <a name="parse_qsl"></a><span class="summary-name">parse_qsl</span>
342 </td>
343 </tr>
344<tr>
345 <td width="15%" align="right" valign="top" class="summary">
346 <span class="summary-type">&nbsp;</span>
347 </td><td class="summary">
348 <a name="HttpError"></a><span class="summary-name">HttpError</span>
349 </td>
350 </tr>
351<tr>
352 <td width="15%" align="right" valign="top" class="summary">
353 <span class="summary-type">&nbsp;</span>
354 </td><td class="summary">
355 <a name="InvalidJsonError"></a><span class="summary-name">InvalidJsonError</span>
356 </td>
357 </tr>
358<tr>
359 <td width="15%" align="right" valign="top" class="summary">
360 <span class="summary-type">&nbsp;</span>
361 </td><td class="summary">
362 <a name="MediaUploadSizeError"></a><span class="summary-name">MediaUploadSizeError</span>
363 </td>
364 </tr>
365<tr>
366 <td width="15%" align="right" valign="top" class="summary">
367 <span class="summary-type">&nbsp;</span>
368 </td><td class="summary">
369 <a name="UnacceptableMimeTypeError"></a><span class="summary-name">UnacceptableMimeTypeError</span>
370 </td>
371 </tr>
372<tr>
373 <td width="15%" align="right" valign="top" class="summary">
374 <span class="summary-type">&nbsp;</span>
375 </td><td class="summary">
376 <a name="UnknownApiNameOrVersion"></a><span class="summary-name">UnknownApiNameOrVersion</span>
377 </td>
378 </tr>
379<tr>
380 <td width="15%" align="right" valign="top" class="summary">
381 <span class="summary-type">&nbsp;</span>
382 </td><td class="summary">
383 <a name="UnknownLinkType"></a><span class="summary-name">UnknownLinkType</span>
384 </td>
385 </tr>
386<tr>
387 <td width="15%" align="right" valign="top" class="summary">
388 <span class="summary-type">&nbsp;</span>
389 </td><td class="summary">
390 <a name="HttpRequest"></a><span class="summary-name">HttpRequest</span>
391 </td>
392 </tr>
393<tr>
394 <td width="15%" align="right" valign="top" class="summary">
395 <span class="summary-type">&nbsp;</span>
396 </td><td class="summary">
397 <a name="MediaFileUpload"></a><span class="summary-name">MediaFileUpload</span>
398 </td>
399 </tr>
400<tr>
401 <td width="15%" align="right" valign="top" class="summary">
402 <span class="summary-type">&nbsp;</span>
403 </td><td class="summary">
404 <a name="MediaUpload"></a><span class="summary-name">MediaUpload</span>
405 </td>
406 </tr>
407<tr>
408 <td width="15%" align="right" valign="top" class="summary">
409 <span class="summary-type">&nbsp;</span>
410 </td><td class="summary">
411 <a name="JsonModel"></a><span class="summary-name">JsonModel</span>
412 </td>
413 </tr>
414<tr>
415 <td width="15%" align="right" valign="top" class="summary">
416 <span class="summary-type">&nbsp;</span>
417 </td><td class="summary">
418 <a name="MediaModel"></a><span class="summary-name">MediaModel</span>
419 </td>
420 </tr>
421<tr>
422 <td width="15%" align="right" valign="top" class="summary">
423 <span class="summary-type">&nbsp;</span>
424 </td><td class="summary">
425 <a name="RawModel"></a><span class="summary-name">RawModel</span>
426 </td>
427 </tr>
428<tr>
429 <td width="15%" align="right" valign="top" class="summary">
430 <span class="summary-type">&nbsp;</span>
431 </td><td class="summary">
432 <a name="Schemas"></a><span class="summary-name">Schemas</span>
433 </td>
434 </tr>
435<tr>
436 <td width="15%" align="right" valign="top" class="summary">
437 <span class="summary-type">&nbsp;</span>
438 </td><td class="summary">
439 <a name="MIMEMultipart"></a><span class="summary-name">MIMEMultipart</span>
440 </td>
441 </tr>
442<tr>
443 <td width="15%" align="right" valign="top" class="summary">
444 <span class="summary-type">&nbsp;</span>
445 </td><td class="summary">
446 <a name="MIMENonMultipart"></a><span class="summary-name">MIMENonMultipart</span>
447 </td>
448 </tr>
449<tr>
450 <td width="15%" align="right" valign="top" class="summary">
451 <span class="summary-type">&nbsp;</span>
452 </td><td class="summary">
453 <a name="positional"></a><span class="summary-name">positional</span>
454 </td>
455 </tr>
456<tr>
457 <td width="15%" align="right" valign="top" class="summary">
458 <span class="summary-type">&nbsp;</span>
459 </td><td class="summary">
460 <a name="simplejson"></a><span class="summary-name">simplejson</span>
461 </td>
462 </tr>
463<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400464 <td width="15%" align="right" valign="top" class="summary">
465 <span class="summary-type">&nbsp;</span>
466 </td><td class="summary">
467 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
468 </td>
469 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400470<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400471 <td width="15%" align="right" valign="top" class="summary">
472 <span class="summary-type">&nbsp;</span>
473 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400474 <a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile('{[^}]*}')">re.compile('{[^}]*}')</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400475 </td>
476 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400477<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400478 <td width="15%" align="right" valign="top" class="summary">
479 <span class="summary-type">&nbsp;</span>
480 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400481 <a name="VARNAME"></a><span class="summary-name">VARNAME</span> = <code title="re.compile('[a-zA-Z0-9_-]+')">re.compile('[a-zA-Z0-9_-]+')</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400482 </td>
483 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400484<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400485 <td width="15%" align="right" valign="top" class="summary">
486 <span class="summary-type">&nbsp;</span>
487 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400488 <a href="apiclient.discovery-module.html#DISCOVERY_URI" class="summary-name">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re\
489st'">'https://www.googleapis.com/discovery/v1/apis/<code class="variable-ellipsis">...</code></code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400490 </td>
491 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400492<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400493 <td width="15%" align="right" valign="top" class="summary">
494 <span class="summary-type">&nbsp;</span>
495 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400496 <a name="DEFAULT_METHOD_DOC"></a><span class="summary-name">DEFAULT_METHOD_DOC</span> = <code title="'A description of how to use this function'">'A description of how to use this function'</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400497 </td>
498 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400499<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400500 <td width="15%" align="right" valign="top" class="summary">
501 <span class="summary-type">&nbsp;</span>
502 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400503 <a name="STACK_QUERY_PARAMETERS"></a><span class="summary-name">STACK_QUERY_PARAMETERS</span> = <code title="['trace', 'pp', 'userip', 'strict']">['trace', 'pp', 'userip', 'strict']</code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400504 </td>
505 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400506<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400507 <td width="15%" align="right" valign="top" class="summary">
508 <span class="summary-type">&nbsp;</span>
509 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400510 <a href="apiclient.discovery-module.html#RESERVED_WORDS" class="summary-name">RESERVED_WORDS</a> = <code title="['and', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', \
511'else', 'except', 'exec', 'finally', 'for', 'from', 'global', 'if', 'i\
512mport', 'in', 'is', 'lambda', 'not', 'or', 'pass', 'print', 'raise', '\
513return', 'try', 'while', 'body']">['and', 'assert', 'break', 'class', 'continue<code class="variable-ellipsis">...</code></code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400514 </td>
515 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400516<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400517 <td width="15%" align="right" valign="top" class="summary">
518 <span class="summary-type">&nbsp;</span>
519 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400520 <a href="apiclient.discovery-module.html#MULTIPLIERS" class="summary-name">MULTIPLIERS</a> = <code title="{&quot;KB&quot;: 2** 10, &quot;MB&quot;: 2** 20, &quot;GB&quot;: 2** 30, &quot;TB&quot;: 2** 40,}">{&quot;KB&quot;: 2** 10, &quot;MB&quot;: 2** 20, &quot;GB&quot;: 2** 30, &quot;TB&quot;:<code class="variable-ellipsis">...</code></code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400521 </td>
522 </tr>
523</table>
524<!-- ==================== FUNCTION DETAILS ==================== -->
525<a name="section-FunctionDetails"></a>
526<table class="details" border="1" cellpadding="3"
527 cellspacing="0" width="100%" bgcolor="white">
528<tr bgcolor="#70b0f0" class="table-header">
529 <td colspan="2" class="table-header">
530 <table border="0" cellpadding="0" cellspacing="0" width="100%">
531 <tr valign="top">
532 <td align="left"><span class="table-header">Function Details</span></td>
533 <td align="right" valign="top"
534 ><span class="options">[<a href="#section-FunctionDetails"
535 class="privatelink" onclick="toggle_private();"
536 >hide private</a>]</span></td>
537 </tr>
538 </table>
539 </td>
540</tr>
541</table>
Joe Gregorio66212032012-06-14 09:10:14 -0400542<a name="fix_method_name"></a>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400543<div>
Joe Gregorio66212032012-06-14 09:10:14 -0400544<table class="details" border="1" cellpadding="3"
545 cellspacing="0" width="100%" bgcolor="white">
546<tr><td>
547 <table width="100%" cellpadding="0" cellspacing="0" border="0">
548 <tr valign="top"><td>
549 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
550 </h3>
551 </td><td align="right" valign="top"
552 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>&nbsp;
553 </td>
554 </tr></table>
555
556 <pre class="literalblock">
557Fix method names to avoid reserved word conflicts.
558
559Args:
560 name: string, method name.
561
562Returns:
563 The name with a '_' prefixed if the name is a reserved word.
564
565</pre>
566 <dl class="fields">
567 </dl>
568</td></tr></table>
569</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400570<a name="_add_query_parameter"></a>
571<div class="private">
572<table class="details" border="1" cellpadding="3"
573 cellspacing="0" width="100%" bgcolor="white">
574<tr><td>
575 <table width="100%" cellpadding="0" cellspacing="0" border="0">
576 <tr valign="top"><td>
577 <h3 class="epydoc"><span class="sig"><span class="sig-name">_add_query_parameter</span>(<span class="sig-arg">url</span>,
578 <span class="sig-arg">name</span>,
579 <span class="sig-arg">value</span>)</span>
580 </h3>
581 </td><td align="right" valign="top"
582 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source&nbsp;code</a></span>&nbsp;
583 </td>
584 </tr></table>
585
586 <pre class="literalblock">
587Adds a query parameter to a url.
588
589Replaces the current value if it already exists in the URL.
590
591Args:
592 url: string, url to add the query parameter to.
593 name: string, query parameter name.
594 value: string, query parameter value.
595
596Returns:
597 Updated query parameter. Does not update the url if value is None.
598
599</pre>
600 <dl class="fields">
601 </dl>
602</td></tr></table>
603</div>
604<a name="key2param"></a>
Joe Gregorio66212032012-06-14 09:10:14 -0400605<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400606<table class="details" border="1" cellpadding="3"
607 cellspacing="0" width="100%" bgcolor="white">
608<tr><td>
609 <table width="100%" cellpadding="0" cellspacing="0" border="0">
610 <tr valign="top"><td>
611 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
612 </h3>
613 </td><td align="right" valign="top"
614 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
615 </td>
616 </tr></table>
617
618 <pre class="literalblock">
619Converts key names into parameter names.
620
621For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
622
Joe Gregorio66212032012-06-14 09:10:14 -0400623Args:
624 key: string, the method key name.
625
626Returns:
627 A safe method name based on the key name.
628
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400629</pre>
630 <dl class="fields">
631 </dl>
632</td></tr></table>
633</div>
634<a name="build"></a>
635<div>
636<table class="details" border="1" cellpadding="3"
637 cellspacing="0" width="100%" bgcolor="white">
638<tr><td>
639 <table width="100%" cellpadding="0" cellspacing="0" border="0">
640 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400641 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
642 <span class="sig-arg">version</span>,
643 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
644 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default">DISCOVERY_URI</span>,
645 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
646 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
647 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400648 </h3>
649 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400650 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400651 </td>
652 </tr></table>
653
654 <pre class="literalblock">
655Construct a Resource for interacting with an API.
656
Joe Gregorio66212032012-06-14 09:10:14 -0400657Construct a Resource object for interacting with an API. The serviceName and
658version are the names from the Discovery service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400659
660Args:
Joe Gregorio66212032012-06-14 09:10:14 -0400661 serviceName: string, name of the service.
662 version: string, the version of the service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400663 http: httplib2.Http, An instance of httplib2.Http or something that acts
664 like it that HTTP requests will be made through.
Joe Gregorio66212032012-06-14 09:10:14 -0400665 discoveryServiceUrl: string, a URI Template that points to the location of
666 the discovery service. It should have two parameters {api} and
667 {apiVersion} that when filled in produce an absolute URI to the discovery
668 document for that service.
669 developerKey: string, key obtained from
670 https://code.google.com/apis/console.
671 model: apiclient.Model, converts to and from the wire format.
672 requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP
673 request.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400674
675Returns:
Joe Gregorio66212032012-06-14 09:10:14 -0400676 A Resource object with methods for interacting with the service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400677
678</pre>
679 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400680 <dt>Decorators:</dt>
681 <dd><ul class="nomargin-top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400682 <li><code>@positional(2)</code></li>
683 </ul></dd>
684 </dl>
685</td></tr></table>
686</div>
687<a name="build_from_document"></a>
688<div>
689<table class="details" border="1" cellpadding="3"
690 cellspacing="0" width="100%" bgcolor="white">
691<tr><td>
692 <table width="100%" cellpadding="0" cellspacing="0" border="0">
693 <tr valign="top"><td>
694 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
695 <span class="sig-arg">base</span>=<span class="sig-default">None</span>,
696 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
697 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
698 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
699 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
700 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>)</span>
701 </h3>
702 </td><td align="right" valign="top"
703 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
704 </td>
705 </tr></table>
706
707 <pre class="literalblock">
708Create a Resource for interacting with an API.
709
710Same as `build()`, but constructs the Resource object from a discovery
711document that is it given, as opposed to retrieving one over HTTP.
712
713Args:
714 service: string, discovery document.
715 base: string, base URI for all HTTP requests, usually the discovery URI.
716 This parameter is no longer used as rootUrl and servicePath are included
717 within the discovery document. (deprecated)
718 future: string, discovery document with future capabilities (deprecated).
719 http: httplib2.Http, An instance of httplib2.Http or something that acts
720 like it that HTTP requests will be made through.
721 developerKey: string, Key for controlling API usage, generated
722 from the API Console.
723 model: Model class instance that serializes and de-serializes requests and
724 responses.
725 requestBuilder: Takes an http request and packages it up to be executed.
726
727Returns:
728 A Resource object with methods for interacting with the service.
729
730</pre>
731 <dl class="fields">
732 <dt>Decorators:</dt>
733 <dd><ul class="nomargin-top">
734 <li><code>@positional(1)</code></li>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400735 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400736 </dl>
737</td></tr></table>
738</div>
739<a name="_cast"></a>
740<div class="private">
741<table class="details" border="1" cellpadding="3"
742 cellspacing="0" width="100%" bgcolor="white">
743<tr><td>
744 <table width="100%" cellpadding="0" cellspacing="0" border="0">
745 <tr valign="top"><td>
746 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
747 <span class="sig-arg">schema_type</span>)</span>
748 </h3>
749 </td><td align="right" valign="top"
750 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
751 </td>
752 </tr></table>
753
754 <pre class="literalblock">
755Convert value to a string based on JSON Schema type.
756
757See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
758JSON Schema.
759
760Args:
761 value: any, the value to convert
762 schema_type: string, the type that value should be interpreted as
763
764Returns:
765 A string representation of 'value' based on the schema_type.
766
767</pre>
768 <dl class="fields">
769 </dl>
770</td></tr></table>
771</div>
Joe Gregorio66212032012-06-14 09:10:14 -0400772<a name="_media_size_to_long"></a>
773<div class="private">
774<table class="details" border="1" cellpadding="3"
775 cellspacing="0" width="100%" bgcolor="white">
776<tr><td>
777 <table width="100%" cellpadding="0" cellspacing="0" border="0">
778 <tr valign="top"><td>
779 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
780 </h3>
781 </td><td align="right" valign="top"
782 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
783 </td>
784 </tr></table>
785
786 <pre class="literalblock">
787Convert a string media size, such as 10GB or 3TB into an integer.
788
789Args:
790 maxSize: string, size as a string, such as 2MB or 7GB.
791
792Returns:
793 The size as an integer value.
794
795</pre>
796 <dl class="fields">
797 </dl>
798</td></tr></table>
799</div>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400800<a name="_createResource"></a>
Joe Gregorio66212032012-06-14 09:10:14 -0400801<div class="private">
802<table class="details" border="1" cellpadding="3"
803 cellspacing="0" width="100%" bgcolor="white">
804<tr><td>
805 <table width="100%" cellpadding="0" cellspacing="0" border="0">
806 <tr valign="top"><td>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400807 <h3 class="epydoc"><span class="sig"><span class="sig-name">_createResource</span>(<span class="sig-arg">http</span>,
Joe Gregorio66212032012-06-14 09:10:14 -0400808 <span class="sig-arg">baseUrl</span>,
809 <span class="sig-arg">model</span>,
810 <span class="sig-arg">requestBuilder</span>,
811 <span class="sig-arg">developerKey</span>,
812 <span class="sig-arg">resourceDesc</span>,
813 <span class="sig-arg">rootDesc</span>,
814 <span class="sig-arg">schema</span>)</span>
815 </h3>
816 </td><td align="right" valign="top"
Joe Gregorioebd0b842012-06-15 14:14:17 -0400817 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_createResource">source&nbsp;code</a></span>&nbsp;
Joe Gregorio66212032012-06-14 09:10:14 -0400818 </td>
819 </tr></table>
820
821 <pre class="literalblock">
822Build a Resource from the API description.
823
824Args:
825 http: httplib2.Http, Object to make http requests with.
826 baseUrl: string, base URL for the API. All requests are relative to this
827 URI.
828 model: apiclient.Model, converts to and from the wire format.
829 requestBuilder: class or callable that instantiates an
830 apiclient.HttpRequest object.
831 developerKey: string, key obtained from
832 https://code.google.com/apis/console
833 resourceDesc: object, section of deserialized discovery document that
834 describes a resource. Note that the top level discovery document
835 is considered a resource.
836 rootDesc: object, the entire deserialized discovery document.
837 schema: object, mapping of schema names to schema descriptions.
838
839Returns:
840 An instance of Resource with all the methods attached for interacting with
841 that resource.
842
843</pre>
844 <dl class="fields">
845 </dl>
846</td></tr></table>
847</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400848<br />
849<!-- ==================== VARIABLES DETAILS ==================== -->
850<a name="section-VariablesDetails"></a>
851<table class="details" border="1" cellpadding="3"
852 cellspacing="0" width="100%" bgcolor="white">
853<tr bgcolor="#70b0f0" class="table-header">
854 <td colspan="2" class="table-header">
855 <table border="0" cellpadding="0" cellspacing="0" width="100%">
856 <tr valign="top">
857 <td align="left"><span class="table-header">Variables Details</span></td>
858 <td align="right" valign="top"
859 ><span class="options">[<a href="#section-VariablesDetails"
860 class="privatelink" onclick="toggle_private();"
861 >hide private</a>]</span></td>
862 </tr>
863 </table>
864 </td>
865</tr>
866</table>
867<a name="DISCOVERY_URI"></a>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400868<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400869<table class="details" border="1" cellpadding="3"
870 cellspacing="0" width="100%" bgcolor="white">
871<tr><td>
872 <h3 class="epydoc">DISCOVERY_URI</h3>
873
874 <dl class="fields">
875 </dl>
876 <dl class="fields">
877 <dt>Value:</dt>
878 <dd><table><tr><td><pre class="variable">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400879'https://www.googleapis.com/discovery/v1/apis/' '{api}/{apiVersion}/re<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
880st'
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400881</pre></td></tr></table>
882</dd>
883 </dl>
884</td></tr></table>
885</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400886<a name="RESERVED_WORDS"></a>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400887<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400888<table class="details" border="1" cellpadding="3"
889 cellspacing="0" width="100%" bgcolor="white">
890<tr><td>
891 <h3 class="epydoc">RESERVED_WORDS</h3>
892
893 <dl class="fields">
894 </dl>
895 <dl class="fields">
896 <dt>Value:</dt>
897 <dd><table><tr><td><pre class="variable">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400898['and', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
899'else', 'except', 'exec', 'finally', 'for', 'from', 'global', 'if', 'i<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
900mport', 'in', 'is', 'lambda', 'not', 'or', 'pass', 'print', 'raise', '<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
901return', 'try', 'while', 'body']
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400902</pre></td></tr></table>
903</dd>
904 </dl>
905</td></tr></table>
906</div>
907<a name="MULTIPLIERS"></a>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400908<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400909<table class="details" border="1" cellpadding="3"
910 cellspacing="0" width="100%" bgcolor="white">
911<tr><td>
912 <h3 class="epydoc">MULTIPLIERS</h3>
913
914 <dl class="fields">
915 </dl>
916 <dl class="fields">
917 <dt>Value:</dt>
918 <dd><table><tr><td><pre class="variable">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400919{&quot;KB&quot;: 2** 10, &quot;MB&quot;: 2** 20, &quot;GB&quot;: 2** 30, &quot;TB&quot;: 2** 40,}
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400920</pre></td></tr></table>
921</dd>
922 </dl>
923</td></tr></table>
924</div>
925<br />
926<!-- ==================== NAVIGATION BAR ==================== -->
927<table class="navbar" border="0" width="100%" cellpadding="0"
928 bgcolor="#a0c0ff" cellspacing="0">
929 <tr valign="middle">
930
931 <!-- Tree link -->
932 <th>&nbsp;&nbsp;&nbsp;<a
933 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
934
935 <!-- Index link -->
936 <th>&nbsp;&nbsp;&nbsp;<a
937 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
938
939 <!-- Help link -->
940 <th>&nbsp;&nbsp;&nbsp;<a
941 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
942
943 <th class="navbar" width="100%"></th>
944 </tr>
945</table>
946<table border="0" cellpadding="0" cellspacing="0" width="100%%">
947 <tr>
948 <td align="left" class="footer">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400949 Generated by Epydoc 3.0.1 on Thu Sep 6 13:36:11 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400950 </td>
951 <td align="right" class="footer">
952 <a target="mainFrame" href="http://epydoc.sourceforge.net"
953 >http://epydoc.sourceforge.net</a>
954 </td>
955 </tr>
956</table>
957
958<script type="text/javascript">
959 <!--
960 // Private objects are initially displayed (because if
961 // javascript is turned off then we want them to be
962 // visible); but by default, we want to hide them. So hide
963 // them unless we have a cookie that says to show them.
964 checkCookie();
965 // -->
966</script>
967</body>
968</html>