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