Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 44454e4c65dda5a2a811553e1cc540140c039fd5 / . / docs / epy / apiclient.schema.Schemas-class.html
blob: 39062c688ed048695051eb0d2e0c8b2de72c7f57 [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 Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_apiclien_28" name="uml_class_diagram_for_apiclien_28">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]59<area shape="rect" href="apiclient.schema.Schemas-class.html#__init__" title="Constructor." alt="" coords="17,36,215,55"/>
60<area shape="rect" href="apiclient.schema.Schemas-class.html#prettyPrintByName" title="Get pretty printed object prototype from the schema name." alt="" coords="17,55,215,73"/>
61<area shape="rect" href="apiclient.schema.Schemas-class.html#prettyPrintSchema" title="Get pretty printed object prototype of schema." alt="" coords="17,73,215,92"/>
62<area shape="rect" href="apiclient.schema.Schemas-class.html#get" title="Get deserialized JSON schema from the schema name." alt="" coords="17,92,215,111"/>
63<area shape="rect" href="apiclient.schema.Schemas-class.html" title="Schemas for an API." alt="" coords="16,11,216,112"/>
64</map>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]65 <img src="uml_class_diagram_for_apiclien_28.gif" alt='' usemap="#uml_class_diagram_for_apiclien_28" 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>
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 />
119 Get pretty printed object prototype from the schema name.</td>
120 <td align="right" valign="top">
121 <span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas._prettyPrintByName">source&nbsp;code</a></span>
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>
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 />
157 Get pretty printed object prototype of schema.</td>
158 <td align="right" valign="top">
159 <span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas._prettyPrintSchema">source&nbsp;code</a></span>
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>
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>
307 </h3>
308 </td><td align="right" valign="top"
309 ><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas._prettyPrintByName">source&nbsp;code</a></span>&nbsp;
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">
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>
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>
371 </h3>
372 </td><td align="right" valign="top"
373 ><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas._prettyPrintSchema">source&nbsp;code</a></span>&nbsp;
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">
391 </dl>
392</td></tr></table>
393</div>
394<a name="prettyPrintSchema"></a>
395<div>
396<table class="details" border="1" cellpadding="3"
397 cellspacing="0" width="100%" bgcolor="white">
398<tr><td>
399 <table width="100%" cellpadding="0" cellspacing="0" border="0">
400 <tr valign="top"><td>
401 <h3 class="epydoc"><span class="sig"><span class="sig-name">prettyPrintSchema</span>(<span class="sig-arg">self</span>,
402 <span class="sig-arg">schema</span>)</span>
403 </h3>
404 </td><td align="right" valign="top"
405 ><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.prettyPrintSchema">source&nbsp;code</a></span>&nbsp;
406 </td>
407 </tr></table>
408
409 <pre class="literalblock">
410Get pretty printed object prototype of schema.
411
412Args:
413 schema: object, Parsed JSON schema.
414
415Returns:
416 string, A string that contains a prototype object with
417 comments that conforms to the given schema.
418
419</pre>
420 <dl class="fields">
421 </dl>
422</td></tr></table>
423</div>
424<a name="get"></a>
425<div>
426<table class="details" border="1" cellpadding="3"
427 cellspacing="0" width="100%" bgcolor="white">
428<tr><td>
429 <table width="100%" cellpadding="0" cellspacing="0" border="0">
430 <tr valign="top"><td>
431 <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>,
432 <span class="sig-arg">name</span>)</span>
433 </h3>
434 </td><td align="right" valign="top"
435 ><span class="codelink"><a href="apiclient.schema-pysrc.html#Schemas.get">source&nbsp;code</a></span>&nbsp;
436 </td>
437 </tr></table>
438
439 <pre class="literalblock">
440Get deserialized JSON schema from the schema name.
441
442Args:
443 name: string, Schema name.
444
445</pre>
446 <dl class="fields">
447 </dl>
448</td></tr></table>
449</div>
450<br />
451<!-- ==================== NAVIGATION BAR ==================== -->
452<table class="navbar" border="0" width="100%" cellpadding="0"
453 bgcolor="#a0c0ff" cellspacing="0">
454 <tr valign="middle">
455
456 <!-- Tree link -->
457 <th>&nbsp;&nbsp;&nbsp;<a
458 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
459
460 <!-- Index link -->
461 <th>&nbsp;&nbsp;&nbsp;<a
462 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
463
464 <!-- Help link -->
465 <th>&nbsp;&nbsp;&nbsp;<a
466 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
467
468 <th class="navbar" width="100%"></th>
469 </tr>
470</table>
471<table border="0" cellpadding="0" cellspacing="0" width="100%%">
472 <tr>
473 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]474 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]475 </td>
476 <td align="right" class="footer">
477 <a target="mainFrame" href="http://epydoc.sourceforge.net"
478 >http://epydoc.sourceforge.net</a>
479 </td>
480 </tr>
481</table>
482
483<script type="text/javascript">
484 <!--
485 // Private objects are initially displayed (because if
486 // javascript is turned off then we want them to be
487 // visible); but by default, we want to hide them. So hide
488 // them unless we have a cookie that says to show them.
489 checkCookie();
490 // -->
491</script>
492</body>
493</html>