Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 6ceea2de24d94155f5c535c4485ee772f07e5c97 / . / docs / epy / apiclient.discovery-module.html
blob: e976d76b0f8425ca76265df5634daa54d2e7183e [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 Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]167 <span class="summary-sig-arg">base</span>=<span class="summary-sig-default">None</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]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>,
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]499 <span class="sig-arg">base</span>=<span class="sig-default">None</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]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.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]520 This parameter is no longer used as rootUrl and servicePath are included
521 within the discovery document. (deprecated)
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]522 future: string, discovery document with future capabilities (deprecated).
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]523 http: httplib2.Http, An instance of httplib2.Http or something that acts
524 like it that HTTP requests will be made through.
525 developerKey: string, Key for controlling API usage, generated
526 from the API Console.
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]527 model: Model class instance that serializes and de-serializes requests and
528 responses.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]529 requestBuilder: Takes an http request and packages it up to be executed.
530
531Returns:
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]532 A Resource object with methods for interacting with the service.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]533
534</pre>
535 <dl class="fields">
536 </dl>
537</td></tr></table>
538</div>
539<a name="_cast"></a>
540<div class="private">
541<table class="details" border="1" cellpadding="3"
542 cellspacing="0" width="100%" bgcolor="white">
543<tr><td>
544 <table width="100%" cellpadding="0" cellspacing="0" border="0">
545 <tr valign="top"><td>
546 <h3 class="epydoc"><span class="sig"><span class="sig-name">_cast</span>(<span class="sig-arg">value</span>,
547 <span class="sig-arg">schema_type</span>)</span>
548 </h3>
549 </td><td align="right" valign="top"
550 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_cast">source&nbsp;code</a></span>&nbsp;
551 </td>
552 </tr></table>
553
554 <pre class="literalblock">
555Convert value to a string based on JSON Schema type.
556
557See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
558JSON Schema.
559
560Args:
561 value: any, the value to convert
562 schema_type: string, the type that value should be interpreted as
563
564Returns:
565 A string representation of 'value' based on the schema_type.
566
567</pre>
568 <dl class="fields">
569 </dl>
570</td></tr></table>
571</div>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]572<a name="_media_size_to_long"></a>
573<div class="private">
574<table class="details" border="1" cellpadding="3"
575 cellspacing="0" width="100%" bgcolor="white">
576<tr><td>
577 <table width="100%" cellpadding="0" cellspacing="0" border="0">
578 <tr valign="top"><td>
579 <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
580 </h3>
581 </td><td align="right" valign="top"
582 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source&nbsp;code</a></span>&nbsp;
583 </td>
584 </tr></table>
585
586 <pre class="literalblock">
587Convert a string media size, such as 10GB or 3TB into an integer.
588
589Args:
590 maxSize: string, size as a string, such as 2MB or 7GB.
591
592Returns:
593 The size as an integer value.
594
595</pre>
596 <dl class="fields">
597 </dl>
598</td></tr></table>
599</div>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]600<a name="_createResource"></a>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]601<div class="private">
602<table class="details" border="1" cellpadding="3"
603 cellspacing="0" width="100%" bgcolor="white">
604<tr><td>
605 <table width="100%" cellpadding="0" cellspacing="0" border="0">
606 <tr valign="top"><td>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]607 <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]608 <span class="sig-arg">baseUrl</span>,
609 <span class="sig-arg">model</span>,
610 <span class="sig-arg">requestBuilder</span>,
611 <span class="sig-arg">developerKey</span>,
612 <span class="sig-arg">resourceDesc</span>,
613 <span class="sig-arg">rootDesc</span>,
614 <span class="sig-arg">schema</span>)</span>
615 </h3>
616 </td><td align="right" valign="top"
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]617 ><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]618 </td>
619 </tr></table>
620
621 <pre class="literalblock">
622Build a Resource from the API description.
623
624Args:
625 http: httplib2.Http, Object to make http requests with.
626 baseUrl: string, base URL for the API. All requests are relative to this
627 URI.
628 model: apiclient.Model, converts to and from the wire format.
629 requestBuilder: class or callable that instantiates an
630 apiclient.HttpRequest object.
631 developerKey: string, key obtained from
632 https://code.google.com/apis/console
633 resourceDesc: object, section of deserialized discovery document that
634 describes a resource. Note that the top level discovery document
635 is considered a resource.
636 rootDesc: object, the entire deserialized discovery document.
637 schema: object, mapping of schema names to schema descriptions.
638
639Returns:
640 An instance of Resource with all the methods attached for interacting with
641 that resource.
642
643</pre>
644 <dl class="fields">
645 </dl>
646</td></tr></table>
647</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]648<br />
649<!-- ==================== VARIABLES DETAILS ==================== -->
650<a name="section-VariablesDetails"></a>
651<table class="details" border="1" cellpadding="3"
652 cellspacing="0" width="100%" bgcolor="white">
653<tr bgcolor="#70b0f0" class="table-header">
654 <td colspan="2" class="table-header">
655 <table border="0" cellpadding="0" cellspacing="0" width="100%">
656 <tr valign="top">
657 <td align="left"><span class="table-header">Variables Details</span></td>
658 <td align="right" valign="top"
659 ><span class="options">[<a href="#section-VariablesDetails"
660 class="privatelink" onclick="toggle_private();"
661 >hide private</a>]</span></td>
662 </tr>
663 </table>
664 </td>
665</tr>
666</table>
667<a name="DISCOVERY_URI"></a>
668<div class="private">
669<table class="details" border="1" cellpadding="3"
670 cellspacing="0" width="100%" bgcolor="white">
671<tr><td>
672 <h3 class="epydoc">DISCOVERY_URI</h3>
673
674 <dl class="fields">
675 </dl>
676 <dl class="fields">
677 <dt>Value:</dt>
678 <dd><table><tr><td><pre class="variable">
679<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>
680</pre></td></tr></table>
681</dd>
682 </dl>
683</td></tr></table>
684</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]685<a name="RESERVED_WORDS"></a>
686<div class="private">
687<table class="details" border="1" cellpadding="3"
688 cellspacing="0" width="100%" bgcolor="white">
689<tr><td>
690 <h3 class="epydoc">RESERVED_WORDS</h3>
691
692 <dl class="fields">
693 </dl>
694 <dl class="fields">
695 <dt>Value:</dt>
696 <dd><table><tr><td><pre class="variable">
697<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>
698 <code class="variable-quote">'</code><code class="variable-string">assert</code><code class="variable-quote">'</code><code class="variable-op">,</code>
699 <code class="variable-quote">'</code><code class="variable-string">break</code><code class="variable-quote">'</code><code class="variable-op">,</code>
700 <code class="variable-quote">'</code><code class="variable-string">class</code><code class="variable-quote">'</code><code class="variable-op">,</code>
701 <code class="variable-quote">'</code><code class="variable-string">continue</code><code class="variable-quote">'</code><code class="variable-op">,</code>
702 <code class="variable-quote">'</code><code class="variable-string">def</code><code class="variable-quote">'</code><code class="variable-op">,</code>
703 <code class="variable-quote">'</code><code class="variable-string">del</code><code class="variable-quote">'</code><code class="variable-op">,</code>
704 <code class="variable-quote">'</code><code class="variable-string">elif</code><code class="variable-quote">'</code><code class="variable-op">,</code>
705<code class="variable-ellipsis">...</code>
706</pre></td></tr></table>
707</dd>
708 </dl>
709</td></tr></table>
710</div>
711<a name="MULTIPLIERS"></a>
712<div class="private">
713<table class="details" border="1" cellpadding="3"
714 cellspacing="0" width="100%" bgcolor="white">
715<tr><td>
716 <h3 class="epydoc">MULTIPLIERS</h3>
717
718 <dl class="fields">
719 </dl>
720 <dl class="fields">
721 <dt>Value:</dt>
722 <dd><table><tr><td><pre class="variable">
723<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>
724</pre></td></tr></table>
725</dd>
726 </dl>
727</td></tr></table>
728</div>
729<br />
730<!-- ==================== NAVIGATION BAR ==================== -->
731<table class="navbar" border="0" width="100%" cellpadding="0"
732 bgcolor="#a0c0ff" cellspacing="0">
733 <tr valign="middle">
734
735 <!-- Tree link -->
736 <th>&nbsp;&nbsp;&nbsp;<a
737 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
738
739 <!-- Index link -->
740 <th>&nbsp;&nbsp;&nbsp;<a
741 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
742
743 <!-- Help link -->
744 <th>&nbsp;&nbsp;&nbsp;<a
745 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
746
747 <th class="navbar" width="100%"></th>
748 </tr>
749</table>
750<table border="0" cellpadding="0" cellspacing="0" width="100%%">
751 <tr>
752 <td align="left" class="footer">
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]753 Generated by Epydoc 3.0.1 on Fri Aug 3 07:38:24 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]754 </td>
755 <td align="right" class="footer">
756 <a target="mainFrame" href="http://epydoc.sourceforge.net"
757 >http://epydoc.sourceforge.net</a>
758 </td>
759 </tr>
760</table>
761
762<script type="text/javascript">
763 <!--
764 // Private objects are initially displayed (because if
765 // javascript is turned off then we want them to be
766 // visible); but by default, we want to hide them. So hide
767 // them unless we have a cookie that says to show them.
768 checkCookie();
769 // -->
770</script>
771</body>
772</html>