Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c29aaa9f8e5155f7a948c149fd2fec14e93f588c / . / docs / epy / apiclient.discovery-module.html
blob: 067bd0f5ce5c8c945374c71dd97bfbe33b2eb863 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -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>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>
84<tr class="private">
85 <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 Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]90 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#fix_method_name" class="summary-sig-name" onclick="show_private();">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br />
91 Fix method names to avoid reserved word conflicts.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]92 <td align="right" valign="top">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]93 <span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]94
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 -0400[diff] [blame]120<tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]121 <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 -0400[diff] [blame]126 <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 -0400[diff] [blame]127 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>
143 <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"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersio</code><code class="variable-ellipsis">...</code></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">&lt;class 'apiclient.http.HttpRequest'&gt;</span>)</span><br />
150 Construct a Resource for interacting with an API.</td>
151 <td align="right" valign="top">
152 <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>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]160<tr class="private">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]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>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]166 <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build_from_document" class="summary-sig-name" onclick="show_private();">build_from_document</a>(<span class="summary-sig-arg">service</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]167 <span class="summary-sig-arg">base</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">&lt;class 'apiclient.http.HttpRequest'&gt;</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>
176
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 -0400[diff] [blame]207 <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 -0400[diff] [blame]208 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 -0400[diff] [blame]224 <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 -0400[diff] [blame]225 <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 -0400[diff] [blame]230 <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 -0400[diff] [blame]233 <td align="right" valign="top">
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]234 <span class="codelink"><a href="apiclient.discovery-pysrc.html#_createResource">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]235
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>
260<tr class="private">
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="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
265 </td>
266 </tr>
267<tr class="private">
268 <td width="15%" align="right" valign="top" class="summary">
269 <span class="summary-type">&nbsp;</span>
270 </td><td class="summary">
271 <a name="URITEMPLATE"></a><span class="summary-name">URITEMPLATE</span> = <code title="re.compile(r'\{[^\}]*\}')">re.compile(r'\{<code class="re-group">[^</code>\}<code class="re-group">]</code><code class="re-op">*</code>\}')</code>
272 </td>
273 </tr>
274<tr class="private">
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="VARNAME"></a><span class="summary-name">VARNAME</span> = <code title="re.compile(r'[a-zA-Z0-9_-]+')">re.compile(r'<code class="re-group">[</code>a<code class="re-op">-</code>zA<code class="re-op">-</code>Z0<code class="re-op">-</code>9_-<code class="re-group">]</code><code class="re-op">+</code>')</code>
279 </td>
280 </tr>
281<tr class="private">
282 <td width="15%" align="right" valign="top" class="summary">
283 <span class="summary-type">&nbsp;</span>
284 </td><td class="summary">
285 <a href="apiclient.discovery-module.html#DISCOVERY_URI" class="summary-name" onclick="show_private();">DISCOVERY_URI</a> = <code title="'https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersion}/rest'"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/</code><code class="variable-ellipsis">...</code></code>
286 </td>
287 </tr>
288<tr class="private">
289 <td width="15%" align="right" valign="top" class="summary">
290 <span class="summary-type">&nbsp;</span>
291 </td><td class="summary">
292 <a name="DEFAULT_METHOD_DOC"></a><span class="summary-name">DEFAULT_METHOD_DOC</span> = <code title="'A description of how to use this function'"><code class="variable-quote">'</code><code class="variable-string">A description of how to use this function</code><code class="variable-quote">'</code></code>
293 </td>
294 </tr>
295<tr class="private">
296 <td width="15%" align="right" valign="top" class="summary">
297 <span class="summary-type">&nbsp;</span>
298 </td><td class="summary">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]299 <a name="STACK_QUERY_PARAMETERS"></a><span class="summary-name">STACK_QUERY_PARAMETERS</span> = <code title="['trace', 'pp', 'userip', 'strict']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">trace</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">pp</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">userip</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">strict</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]300 </td>
301 </tr>
302<tr class="private">
303 <td width="15%" align="right" valign="top" class="summary">
304 <span class="summary-type">&nbsp;</span>
305 </td><td class="summary">
306 <a href="apiclient.discovery-module.html#RESERVED_WORDS" class="summary-name" onclick="show_private();">RESERVED_WORDS</a> = <code title="['and',
307 'assert',
308 'break',
309 'class',
310 'continue',
311 'def',
312 'del',
313 'elif',
314..."><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">and</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">assert</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">break</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">class</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">continue</code><code class="variable-ellipsis">...</code></code>
315 </td>
316 </tr>
317<tr class="private">
318 <td width="15%" align="right" valign="top" class="summary">
319 <span class="summary-type">&nbsp;</span>
320 </td><td class="summary">
321 <a href="apiclient.discovery-module.html#MULTIPLIERS" class="summary-name" onclick="show_private();">MULTIPLIERS</a> = <code title="{'GB': 1073741824, 'KB': 1024, 'MB': 1048576, 'TB': 1099511627776}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">GB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1073741824<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">KB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1024<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">MB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1048576<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">T</code><code class="variable-ellipsis">...</code></code>
322 </td>
323 </tr>
324<tr class="private">
325 <td width="15%" align="right" valign="top" class="summary">
326 <span class="summary-type">&nbsp;</span>
327 </td><td class="summary">
328 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'apiclient'"><code class="variable-quote">'</code><code class="variable-string">apiclient</code><code class="variable-quote">'</code></code>
329 </td>
330 </tr>
331</table>
332<!-- ==================== FUNCTION DETAILS ==================== -->
333<a name="section-FunctionDetails"></a>
334<table class="details" border="1" cellpadding="3"
335 cellspacing="0" width="100%" bgcolor="white">
336<tr bgcolor="#70b0f0" class="table-header">
337 <td colspan="2" class="table-header">
338 <table border="0" cellpadding="0" cellspacing="0" width="100%">
339 <tr valign="top">
340 <td align="left"><span class="table-header">Function Details</span></td>
341 <td align="right" valign="top"
342 ><span class="options">[<a href="#section-FunctionDetails"
343 class="privatelink" onclick="toggle_private();"
344 >hide private</a>]</span></td>
345 </tr>
346 </table>
347 </td>
348</tr>
349</table>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]350<a name="fix_method_name"></a>
351<div class="private">
352<table class="details" border="1" cellpadding="3"
353 cellspacing="0" width="100%" bgcolor="white">
354<tr><td>
355 <table width="100%" cellpadding="0" cellspacing="0" border="0">
356 <tr valign="top"><td>
357 <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
358 </h3>
359 </td><td align="right" valign="top"
360 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source&nbsp;code</a></span>&nbsp;
361 </td>
362 </tr></table>
363
364 <pre class="literalblock">
365Fix method names to avoid reserved word conflicts.
366
367Args:
368 name: string, method name.
369
370Returns:
371 The name with a '_' prefixed if the name is a reserved word.
372
373</pre>
374 <dl class="fields">
375 </dl>
376</td></tr></table>
377</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]378<a name="_add_query_parameter"></a>
379<div class="private">
380<table class="details" border="1" cellpadding="3"
381 cellspacing="0" width="100%" bgcolor="white">
382<tr><td>
383 <table width="100%" cellpadding="0" cellspacing="0" border="0">
384 <tr valign="top"><td>
385 <h3 class="epydoc"><span class="sig"><span class="sig-name">_add_query_parameter</span>(<span class="sig-arg">url</span>,
386 <span class="sig-arg">name</span>,
387 <span class="sig-arg">value</span>)</span>
388 </h3>
389 </td><td align="right" valign="top"
390 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_add_query_parameter">source&nbsp;code</a></span>&nbsp;
391 </td>
392 </tr></table>
393
394 <pre class="literalblock">
395Adds a query parameter to a url.
396
397Replaces the current value if it already exists in the URL.
398
399Args:
400 url: string, url to add the query parameter to.
401 name: string, query parameter name.
402 value: string, query parameter value.
403
404Returns:
405 Updated query parameter. Does not update the url if value is None.
406
407</pre>
408 <dl class="fields">
409 </dl>
410</td></tr></table>
411</div>
412<a name="key2param"></a>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]413<div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]414<table class="details" border="1" cellpadding="3"
415 cellspacing="0" width="100%" bgcolor="white">
416<tr><td>
417 <table width="100%" cellpadding="0" cellspacing="0" border="0">
418 <tr valign="top"><td>
419 <h3 class="epydoc"><span class="sig"><span class="sig-name">key2param</span>(<span class="sig-arg">key</span>)</span>
420 </h3>
421 </td><td align="right" valign="top"
422 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source&nbsp;code</a></span>&nbsp;
423 </td>
424 </tr></table>
425
426 <pre class="literalblock">
427Converts key names into parameter names.
428
429For example, converting &quot;max-results&quot; -&gt; &quot;max_results&quot;
430
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]431Args:
432 key: string, the method key name.
433
434Returns:
435 A safe method name based on the key name.
436
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]437</pre>
438 <dl class="fields">
439 </dl>
440</td></tr></table>
441</div>
442<a name="build"></a>
443<div>
444<table class="details" border="1" cellpadding="3"
445 cellspacing="0" width="100%" bgcolor="white">
446<tr><td>
447 <table width="100%" cellpadding="0" cellspacing="0" border="0">
448 <tr valign="top"><td>
449 <h3 class="epydoc"><span class="sig"><span class="sig-name">build</span>(<span class="sig-arg">serviceName</span>,
450 <span class="sig-arg">version</span>,
451 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
452 <span class="sig-arg">discoveryServiceUrl</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersio</code><code class="variable-ellipsis">...</code></span>,
453 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
454 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
455 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">&lt;class 'apiclient.http.HttpRequest'&gt;</span>)</span>
456 </h3>
457 </td><td align="right" valign="top"
458 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build">source&nbsp;code</a></span>&nbsp;
459 </td>
460 </tr></table>
461
462 <pre class="literalblock">
463Construct a Resource for interacting with an API.
464
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]465Construct a Resource object for interacting with an API. The serviceName and
466version are the names from the Discovery service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]467
468Args:
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]469 serviceName: string, name of the service.
470 version: string, the version of the service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]471 http: httplib2.Http, An instance of httplib2.Http or something that acts
472 like it that HTTP requests will be made through.
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]473 discoveryServiceUrl: string, a URI Template that points to the location of
474 the discovery service. It should have two parameters {api} and
475 {apiVersion} that when filled in produce an absolute URI to the discovery
476 document for that service.
477 developerKey: string, key obtained from
478 https://code.google.com/apis/console.
479 model: apiclient.Model, converts to and from the wire format.
480 requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP
481 request.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]482
483Returns:
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]484 A Resource object with methods for interacting with the service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]485
486</pre>
487 <dl class="fields">
488 </dl>
489</td></tr></table>
490</div>
491<a name="build_from_document"></a>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]492<div class="private">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]493<table class="details" border="1" cellpadding="3"
494 cellspacing="0" width="100%" bgcolor="white">
495<tr><td>
496 <table width="100%" cellpadding="0" cellspacing="0" border="0">
497 <tr valign="top"><td>
498 <h3 class="epydoc"><span class="sig"><span class="sig-name">build_from_document</span>(<span class="sig-arg">service</span>,
499 <span class="sig-arg">base</span>,
500 <span class="sig-arg">future</span>=<span class="sig-default">None</span>,
501 <span class="sig-arg">http</span>=<span class="sig-default">None</span>,
502 <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
503 <span class="sig-arg">model</span>=<span class="sig-default">None</span>,
504 <span class="sig-arg">requestBuilder</span>=<span class="sig-default">&lt;class 'apiclient.http.HttpRequest'&gt;</span>)</span>
505 </h3>
506 </td><td align="right" valign="top"
507 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#build_from_document">source&nbsp;code</a></span>&nbsp;
508 </td>
509 </tr></table>
510
511 <pre class="literalblock">
512Create a Resource for interacting with an API.
513
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]514Same as `build()`, but constructs the Resource object from a discovery
515document that is it given, as opposed to retrieving one over HTTP.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]516
517Args:
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]518 service: string, discovery document.
519 base: string, base URI for all HTTP requests, usually the discovery URI.
520 future: string, discovery document with future capabilities (deprecated).
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]521 http: httplib2.Http, An instance of httplib2.Http or something that acts
522 like it that HTTP requests will be made through.
523 developerKey: string, Key for controlling API usage, generated
524 from the API Console.
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]525 model: Model class instance that serializes and de-serializes requests and
526 responses.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]527 requestBuilder: Takes an http request and packages it up to be executed.
528
529Returns:
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]530 A Resource object with methods for interacting with the service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]531
532</pre>
533 <dl class="fields">
534 </dl>
535</td></tr></table>
536</div>
537<a name="_cast"></a>
538<div class="private">
539<table class="details" border="1" cellpadding="3"
540 cellspacing="0" width="100%" bgcolor="white">
541<tr><td>
542 <table width="100%" cellpadding="0" cellspacing="0" border="0">
543 <tr valign="top"><td>
544 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
545 <span class="sig-arg">schema_type</span>)</span>
546 </h3>
547 </td><td align="right" valign="top"
548 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
549 </td>
550 </tr></table>
551
552 <pre class="literalblock">
553Convert value to a string based on JSON Schema type.
554
555See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
556JSON Schema.
557
558Args:
559 value: any, the value to convert
560 schema_type: string, the type that value should be interpreted as
561
562Returns:
563 A string representation of 'value' based on the schema_type.
564
565</pre>
566 <dl class="fields">
567 </dl>
568</td></tr></table>
569</div>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]570<a name="_media_size_to_long"></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">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
578 </h3>
579 </td><td align="right" valign="top"
580 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
581 </td>
582 </tr></table>
583
584 <pre class="literalblock">
585Convert a string media size, such as 10GB or 3TB into an integer.
586
587Args:
588 maxSize: string, size as a string, such as 2MB or 7GB.
589
590Returns:
591 The size as an integer value.
592
593</pre>
594 <dl class="fields">
595 </dl>
596</td></tr></table>
597</div>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]598<a name="_createResource"></a>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]599<div class="private">
600<table class="details" border="1" cellpadding="3"
601 cellspacing="0" width="100%" bgcolor="white">
602<tr><td>
603 <table width="100%" cellpadding="0" cellspacing="0" border="0">
604 <tr valign="top"><td>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]605 <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 -0400[diff] [blame]606 <span class="sig-arg">baseUrl</span>,
607 <span class="sig-arg">model</span>,
608 <span class="sig-arg">requestBuilder</span>,
609 <span class="sig-arg">developerKey</span>,
610 <span class="sig-arg">resourceDesc</span>,
611 <span class="sig-arg">rootDesc</span>,
612 <span class="sig-arg">schema</span>)</span>
613 </h3>
614 </td><td align="right" valign="top"
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]615 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_createResource">source&nbsp;code</a></span>&nbsp;
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]616 </td>
617 </tr></table>
618
619 <pre class="literalblock">
620Build a Resource from the API description.
621
622Args:
623 http: httplib2.Http, Object to make http requests with.
624 baseUrl: string, base URL for the API. All requests are relative to this
625 URI.
626 model: apiclient.Model, converts to and from the wire format.
627 requestBuilder: class or callable that instantiates an
628 apiclient.HttpRequest object.
629 developerKey: string, key obtained from
630 https://code.google.com/apis/console
631 resourceDesc: object, section of deserialized discovery document that
632 describes a resource. Note that the top level discovery document
633 is considered a resource.
634 rootDesc: object, the entire deserialized discovery document.
635 schema: object, mapping of schema names to schema descriptions.
636
637Returns:
638 An instance of Resource with all the methods attached for interacting with
639 that resource.
640
641</pre>
642 <dl class="fields">
643 </dl>
644</td></tr></table>
645</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]646<br />
647<!-- ==================== VARIABLES DETAILS ==================== -->
648<a name="section-VariablesDetails"></a>
649<table class="details" border="1" cellpadding="3"
650 cellspacing="0" width="100%" bgcolor="white">
651<tr bgcolor="#70b0f0" class="table-header">
652 <td colspan="2" class="table-header">
653 <table border="0" cellpadding="0" cellspacing="0" width="100%">
654 <tr valign="top">
655 <td align="left"><span class="table-header">Variables Details</span></td>
656 <td align="right" valign="top"
657 ><span class="options">[<a href="#section-VariablesDetails"
658 class="privatelink" onclick="toggle_private();"
659 >hide private</a>]</span></td>
660 </tr>
661 </table>
662 </td>
663</tr>
664</table>
665<a name="DISCOVERY_URI"></a>
666<div class="private">
667<table class="details" border="1" cellpadding="3"
668 cellspacing="0" width="100%" bgcolor="white">
669<tr><td>
670 <h3 class="epydoc">DISCOVERY_URI</h3>
671
672 <dl class="fields">
673 </dl>
674 <dl class="fields">
675 <dt>Value:</dt>
676 <dd><table><tr><td><pre class="variable">
677<code class="variable-quote">'</code><code class="variable-string">https://www.googleapis.com/discovery/v1/apis/{api}/{apiVersion}/rest</code><code class="variable-quote">'</code>
678</pre></td></tr></table>
679</dd>
680 </dl>
681</td></tr></table>
682</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]683<a name="RESERVED_WORDS"></a>
684<div class="private">
685<table class="details" border="1" cellpadding="3"
686 cellspacing="0" width="100%" bgcolor="white">
687<tr><td>
688 <h3 class="epydoc">RESERVED_WORDS</h3>
689
690 <dl class="fields">
691 </dl>
692 <dl class="fields">
693 <dt>Value:</dt>
694 <dd><table><tr><td><pre class="variable">
695<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">and</code><code class="variable-quote">'</code><code class="variable-op">,</code>
696 <code class="variable-quote">'</code><code class="variable-string">assert</code><code class="variable-quote">'</code><code class="variable-op">,</code>
697 <code class="variable-quote">'</code><code class="variable-string">break</code><code class="variable-quote">'</code><code class="variable-op">,</code>
698 <code class="variable-quote">'</code><code class="variable-string">class</code><code class="variable-quote">'</code><code class="variable-op">,</code>
699 <code class="variable-quote">'</code><code class="variable-string">continue</code><code class="variable-quote">'</code><code class="variable-op">,</code>
700 <code class="variable-quote">'</code><code class="variable-string">def</code><code class="variable-quote">'</code><code class="variable-op">,</code>
701 <code class="variable-quote">'</code><code class="variable-string">del</code><code class="variable-quote">'</code><code class="variable-op">,</code>
702 <code class="variable-quote">'</code><code class="variable-string">elif</code><code class="variable-quote">'</code><code class="variable-op">,</code>
703<code class="variable-ellipsis">...</code>
704</pre></td></tr></table>
705</dd>
706 </dl>
707</td></tr></table>
708</div>
709<a name="MULTIPLIERS"></a>
710<div class="private">
711<table class="details" border="1" cellpadding="3"
712 cellspacing="0" width="100%" bgcolor="white">
713<tr><td>
714 <h3 class="epydoc">MULTIPLIERS</h3>
715
716 <dl class="fields">
717 </dl>
718 <dl class="fields">
719 <dt>Value:</dt>
720 <dd><table><tr><td><pre class="variable">
721<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">GB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1073741824<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">KB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1024<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">MB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1048576<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">TB</code><code class="variable-quote">'</code><code class="variable-op">: </code>1099511627776<code class="variable-group">}</code>
722</pre></td></tr></table>
723</dd>
724 </dl>
725</td></tr></table>
726</div>
727<br />
728<!-- ==================== NAVIGATION BAR ==================== -->
729<table class="navbar" border="0" width="100%" cellpadding="0"
730 bgcolor="#a0c0ff" cellspacing="0">
731 <tr valign="middle">
732
733 <!-- Tree link -->
734 <th>&nbsp;&nbsp;&nbsp;<a
735 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
736
737 <!-- Index link -->
738 <th>&nbsp;&nbsp;&nbsp;<a
739 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
740
741 <!-- Help link -->
742 <th>&nbsp;&nbsp;&nbsp;<a
743 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
744
745 <th class="navbar" width="100%"></th>
746 </tr>
747</table>
748<table border="0" cellpadding="0" cellspacing="0" width="100%%">
749 <tr>
750 <td align="left" class="footer">
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]751 Generated by Epydoc 3.0.1 on Thu Jul 12 10:44:08 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]752 </td>
753 <td align="right" class="footer">
754 <a target="mainFrame" href="http://epydoc.sourceforge.net"
755 >http://epydoc.sourceforge.net</a>
756 </td>
757 </tr>
758</table>
759
760<script type="text/javascript">
761 <!--
762 // Private objects are initially displayed (because if
763 // javascript is turned off then we want them to be
764 // visible); but by default, we want to hide them. So hide
765 // them unless we have a cookie that says to show them.
766 checkCookie();
767 // -->
768</script>
769</body>
770</html>