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