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