Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1b425aab261532e775551125c8f7aca3562de144 / . / docs / epy / apiclient.schema.Schemas-class.html
blob: 080e5eec705699553bb5a8f6a5bce0094156ed41 [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.schema.Schemas</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 <a href="apiclient.schema-module.html">Module&nbsp;schema</a> ::
39 Class&nbsp;Schemas
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="apiclient.schema.Schemas-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class Schemas</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]58<center> <map id="class_hierarchy_for_schemas" name="class_hierarchy_for_schemas">
59<area shape="rect" href="apiclient.schema.Schemas-class.html" title="Schemas" alt="" coords="5,5,80,32"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]60</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]61 <img src="class_hierarchy_for_schemas.gif" alt='' usemap="#class_hierarchy_for_schemas" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]62</center>
63</center>
64<hr />
65<pre class="literalblock">
66Schemas for an API.
67
68</pre>
69
70<!-- ==================== INSTANCE METHODS ==================== -->
71<a name="section-InstanceMethods"></a>
72<table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74<tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Instance Methods</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-InstanceMethods"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr>
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <table width="100%" cellpadding="0" cellspacing="0" border="0">
92 <tr>
93 <td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
94 <span class="summary-sig-arg">discovery</span>)</span><br />
95 Constructor.</td>
96 <td align="right" valign="top">
97 <span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.__init__">source&nbsp;code</a></span>
98
99 </td>
100 </tr>
101 </table>
102
103 </td>
104 </tr>
105<tr class="private">
106 <td width="15%" align="right" valign="top" class="summary">
107 <span class="summary-type">&nbsp;</span>
108 </td><td class="summary">
109 <table width="100%" cellpadding="0" cellspacing="0" border="0">
110 <tr>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]111 <td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#_prettyPrintByName" class="summary-sig-name" onclick="show_private();">_prettyPrintByName</a>(<span class="summary-sig-arg">*args</span>,
112 <span class="summary-sig-arg">**kwargs</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]113 Get pretty printed object prototype from the schema name.</td>
114 <td align="right" valign="top">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]115 <span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]116
117 </td>
118 </tr>
119 </table>
120
121 </td>
122 </tr>
123<tr>
124 <td width="15%" align="right" valign="top" class="summary">
125 <span class="summary-type">&nbsp;</span>
126 </td><td class="summary">
127 <table width="100%" cellpadding="0" cellspacing="0" border="0">
128 <tr>
129 <td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#prettyPrintByName" class="summary-sig-name">prettyPrintByName</a>(<span class="summary-sig-arg">self</span>,
130 <span class="summary-sig-arg">name</span>)</span><br />
131 Get pretty printed object prototype from the schema name.</td>
132 <td align="right" valign="top">
133 <span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.prettyPrintByName">source&nbsp;code</a></span>
134
135 </td>
136 </tr>
137 </table>
138
139 </td>
140 </tr>
141<tr class="private">
142 <td width="15%" align="right" valign="top" class="summary">
143 <span class="summary-type">&nbsp;</span>
144 </td><td class="summary">
145 <table width="100%" cellpadding="0" cellspacing="0" border="0">
146 <tr>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]147 <td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#_prettyPrintSchema" class="summary-sig-name" onclick="show_private();">_prettyPrintSchema</a>(<span class="summary-sig-arg">*args</span>,
148 <span class="summary-sig-arg">**kwargs</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]149 Get pretty printed object prototype of schema.</td>
150 <td align="right" valign="top">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]151 <span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]152
153 </td>
154 </tr>
155 </table>
156
157 </td>
158 </tr>
159<tr>
160 <td width="15%" align="right" valign="top" class="summary">
161 <span class="summary-type">&nbsp;</span>
162 </td><td class="summary">
163 <table width="100%" cellpadding="0" cellspacing="0" border="0">
164 <tr>
165 <td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#prettyPrintSchema" class="summary-sig-name">prettyPrintSchema</a>(<span class="summary-sig-arg">self</span>,
166 <span class="summary-sig-arg">schema</span>)</span><br />
167 Get pretty printed object prototype of schema.</td>
168 <td align="right" valign="top">
169 <span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.prettyPrintSchema">source&nbsp;code</a></span>
170
171 </td>
172 </tr>
173 </table>
174
175 </td>
176 </tr>
177<tr>
178 <td width="15%" align="right" valign="top" class="summary">
179 <span class="summary-type">&nbsp;</span>
180 </td><td class="summary">
181 <table width="100%" cellpadding="0" cellspacing="0" border="0">
182 <tr>
183 <td><span class="summary-sig"><a href="apiclient.schema.Schemas-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>,
184 <span class="summary-sig-arg">name</span>)</span><br />
185 Get deserialized JSON schema from the schema name.</td>
186 <td align="right" valign="top">
187 <span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.get">source&nbsp;code</a></span>
188
189 </td>
190 </tr>
191 </table>
192
193 </td>
194 </tr>
195 <tr>
196 <td colspan="2" class="summary">
197 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
198 <code>__delattr__</code>,
199 <code>__format__</code>,
200 <code>__getattribute__</code>,
201 <code>__hash__</code>,
202 <code>__new__</code>,
203 <code>__reduce__</code>,
204 <code>__reduce_ex__</code>,
205 <code>__repr__</code>,
206 <code>__setattr__</code>,
207 <code>__sizeof__</code>,
208 <code>__str__</code>,
209 <code>__subclasshook__</code>
210 </p>
211 </td>
212 </tr>
213</table>
214<!-- ==================== PROPERTIES ==================== -->
215<a name="section-Properties"></a>
216<table class="summary" border="1" cellpadding="3"
217 cellspacing="0" width="100%" bgcolor="white">
218<tr bgcolor="#70b0f0" class="table-header">
219 <td colspan="2" class="table-header">
220 <table border="0" cellpadding="0" cellspacing="0" width="100%">
221 <tr valign="top">
222 <td align="left"><span class="table-header">Properties</span></td>
223 <td align="right" valign="top"
224 ><span class="options">[<a href="#section-Properties"
225 class="privatelink" onclick="toggle_private();"
226 >hide private</a>]</span></td>
227 </tr>
228 </table>
229 </td>
230</tr>
231 <tr>
232 <td colspan="2" class="summary">
233 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
234 <code>__class__</code>
235 </p>
236 </td>
237 </tr>
238</table>
239<!-- ==================== METHOD DETAILS ==================== -->
240<a name="section-MethodDetails"></a>
241<table class="details" border="1" cellpadding="3"
242 cellspacing="0" width="100%" bgcolor="white">
243<tr bgcolor="#70b0f0" class="table-header">
244 <td colspan="2" class="table-header">
245 <table border="0" cellpadding="0" cellspacing="0" width="100%">
246 <tr valign="top">
247 <td align="left"><span class="table-header">Method Details</span></td>
248 <td align="right" valign="top"
249 ><span class="options">[<a href="#section-MethodDetails"
250 class="privatelink" onclick="toggle_private();"
251 >hide private</a>]</span></td>
252 </tr>
253 </table>
254 </td>
255</tr>
256</table>
257<a name="__init__"></a>
258<div>
259<table class="details" border="1" cellpadding="3"
260 cellspacing="0" width="100%" bgcolor="white">
261<tr><td>
262 <table width="100%" cellpadding="0" cellspacing="0" border="0">
263 <tr valign="top"><td>
264 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
265 <span class="sig-arg">discovery</span>)</span>
266 <br /><em class="fname">(Constructor)</em>
267 </h3>
268 </td><td align="right" valign="top"
269 ><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.__init__">source&nbsp;code</a></span>&nbsp;
270 </td>
271 </tr></table>
272
273 <pre class="literalblock">
274Constructor.
275
276Args:
277 discovery: object, Deserialized discovery document from which we pull
278 out the named schema.
279
280</pre>
281 <dl class="fields">
282 <dt>Overrides:
283 object.__init__
284 </dt>
285 </dl>
286</td></tr></table>
287</div>
288<a name="_prettyPrintByName"></a>
289<div class="private">
290<table class="details" border="1" cellpadding="3"
291 cellspacing="0" width="100%" bgcolor="white">
292<tr><td>
293 <table width="100%" cellpadding="0" cellspacing="0" border="0">
294 <tr valign="top"><td>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]295 <h3 class="epydoc"><span class="sig"><span class="sig-name">_prettyPrintByName</span>(<span class="sig-arg">*args</span>,
296 <span class="sig-arg">**kwargs</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]297 </h3>
298 </td><td align="right" valign="top"
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]299 ><span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]300 </td>
301 </tr></table>
302
303 <pre class="literalblock">
304Get pretty printed object prototype from the schema name.
305
306Args:
307 name: string, Name of schema in the discovery document.
308 seen: list of string, Names of schema already seen. Used to handle
309 recursive definitions.
310
311Returns:
312 string, A string that contains a prototype object with
313 comments that conforms to the given schema.
314
315</pre>
316 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]317 <dt>Decorators:</dt>
318 <dd><ul class="nomargin-top">
319 <li><code>@util.positional(2)</code></li>
320 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]321 </dl>
322</td></tr></table>
323</div>
324<a name="prettyPrintByName"></a>
325<div>
326<table class="details" border="1" cellpadding="3"
327 cellspacing="0" width="100%" bgcolor="white">
328<tr><td>
329 <table width="100%" cellpadding="0" cellspacing="0" border="0">
330 <tr valign="top"><td>
331 <h3 class="epydoc"><span class="sig"><span class="sig-name">prettyPrintByName</span>(<span class="sig-arg">self</span>,
332 <span class="sig-arg">name</span>)</span>
333 </h3>
334 </td><td align="right" valign="top"
335 ><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.prettyPrintByName">source&nbsp;code</a></span>&nbsp;
336 </td>
337 </tr></table>
338
339 <pre class="literalblock">
340Get pretty printed object prototype from the schema name.
341
342Args:
343 name: string, Name of schema in the discovery document.
344
345Returns:
346 string, A string that contains a prototype object with
347 comments that conforms to the given schema.
348
349</pre>
350 <dl class="fields">
351 </dl>
352</td></tr></table>
353</div>
354<a name="_prettyPrintSchema"></a>
355<div class="private">
356<table class="details" border="1" cellpadding="3"
357 cellspacing="0" width="100%" bgcolor="white">
358<tr><td>
359 <table width="100%" cellpadding="0" cellspacing="0" border="0">
360 <tr valign="top"><td>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]361 <h3 class="epydoc"><span class="sig"><span class="sig-name">_prettyPrintSchema</span>(<span class="sig-arg">*args</span>,
362 <span class="sig-arg">**kwargs</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]363 </h3>
364 </td><td align="right" valign="top"
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]365 ><span class="codelink"><a href="oauth2client.util-pysrc.html">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]366 </td>
367 </tr></table>
368
369 <pre class="literalblock">
370Get pretty printed object prototype of schema.
371
372Args:
373 schema: object, Parsed JSON schema.
374 seen: list of string, Names of schema already seen. Used to handle
375 recursive definitions.
376
377Returns:
378 string, A string that contains a prototype object with
379 comments that conforms to the given schema.
380
381</pre>
382 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]383 <dt>Decorators:</dt>
384 <dd><ul class="nomargin-top">
385 <li><code>@util.positional(2)</code></li>
386 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]387 </dl>
388</td></tr></table>
389</div>
390<a name="prettyPrintSchema"></a>
391<div>
392<table class="details" border="1" cellpadding="3"
393 cellspacing="0" width="100%" bgcolor="white">
394<tr><td>
395 <table width="100%" cellpadding="0" cellspacing="0" border="0">
396 <tr valign="top"><td>
397 <h3 class="epydoc"><span class="sig"><span class="sig-name">prettyPrintSchema</span>(<span class="sig-arg">self</span>,
398 <span class="sig-arg">schema</span>)</span>
399 </h3>
400 </td><td align="right" valign="top"
401 ><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.prettyPrintSchema">source&nbsp;code</a></span>&nbsp;
402 </td>
403 </tr></table>
404
405 <pre class="literalblock">
406Get pretty printed object prototype of schema.
407
408Args:
409 schema: object, Parsed JSON schema.
410
411Returns:
412 string, A string that contains a prototype object with
413 comments that conforms to the given schema.
414
415</pre>
416 <dl class="fields">
417 </dl>
418</td></tr></table>
419</div>
420<a name="get"></a>
421<div>
422<table class="details" border="1" cellpadding="3"
423 cellspacing="0" width="100%" bgcolor="white">
424<tr><td>
425 <table width="100%" cellpadding="0" cellspacing="0" border="0">
426 <tr valign="top"><td>
427 <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>,
428 <span class="sig-arg">name</span>)</span>
429 </h3>
430 </td><td align="right" valign="top"
431 ><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.get">source&nbsp;code</a></span>&nbsp;
432 </td>
433 </tr></table>
434
435 <pre class="literalblock">
436Get deserialized JSON schema from the schema name.
437
438Args:
439 name: string, Schema name.
440
441</pre>
442 <dl class="fields">
443 </dl>
444</td></tr></table>
445</div>
446<br />
447<!-- ==================== NAVIGATION BAR ==================== -->
448<table class="navbar" border="0" width="100%" cellpadding="0"
449 bgcolor="#a0c0ff" cellspacing="0">
450 <tr valign="middle">
451
452 <!-- Tree link -->
453 <th>&nbsp;&nbsp;&nbsp;<a
454 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
455
456 <!-- Index link -->
457 <th>&nbsp;&nbsp;&nbsp;<a
458 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
459
460 <!-- Help link -->
461 <th>&nbsp;&nbsp;&nbsp;<a
462 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
463
464 <th class="navbar" width="100%"></th>
465 </tr>
466</table>
467<table border="0" cellpadding="0" cellspacing="0" width="100%%">
468 <tr>
469 <td align="left" class="footer">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame^]470 Generated by Epydoc 3.0.1 on Fri Aug 24 11:02:04 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]471 </td>
472 <td align="right" class="footer">
473 <a target="mainFrame" href="http://epydoc.sourceforge.net"
474 >http://epydoc.sourceforge.net</a>
475 </td>
476 </tr>
477</table>
478
479<script type="text/javascript">
480 <!--
481 // Private objects are initially displayed (because if
482 // javascript is turned off then we want them to be
483 // visible); but by default, we want to hide them. So hide
484 // them unless we have a cookie that says to show them.
485 checkCookie();
486 // -->
487</script>
488</body>
489</html>