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<pre class="base-tree">
61object --+
62         |
63        <strong class="uidshort">Schemas</strong>
64</pre>
65
66<hr />
67<p>Schemas for an API.</p>
68
69<!-- ==================== INSTANCE METHODS ==================== -->
70<a name="section-InstanceMethods"></a>
71<table class="summary" border="1" cellpadding="3"
72       cellspacing="0" width="100%" bgcolor="white">
73<tr bgcolor="#70b0f0" class="table-header">
74  <td colspan="2" class="table-header">
75    <table border="0" cellpadding="0" cellspacing="0" width="100%">
76      <tr valign="top">
77        <td align="left"><span class="table-header">Instance Methods</span></td>
78        <td align="right" valign="top"
79         ><span class="options">[<a href="#section-InstanceMethods"
80         class="privatelink" onclick="toggle_private();"
81         >hide private</a>]</span></td>
82      </tr>
83    </table>
84  </td>
85</tr>
86<tr>
87    <td width="15%" align="right" valign="top" class="summary">
88      <span class="summary-type">&nbsp;</span>
89    </td><td class="summary">
90      <table width="100%" cellpadding="0" cellspacing="0" border="0">
91        <tr>
92          <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>,
93        <span class="summary-sig-arg">discovery</span>)</span><br />
94      Constructor.</td>
95          <td align="right" valign="top">
96            <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.__init__">source&nbsp;code</a></span>
97
98          </td>
99        </tr>
100      </table>
101
102    </td>
103  </tr>
104<tr class="private">
105    <td width="15%" align="right" valign="top" class="summary">
106      <span class="summary-type">&nbsp;</span>
107    </td><td class="summary">
108      <table width="100%" cellpadding="0" cellspacing="0" border="0">
109        <tr>
110          <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">*args</span>,
111        <span class="summary-sig-arg">**kwargs</span>)</span><br />
112      Get pretty printed object prototype from the schema name.</td>
113          <td align="right" valign="top">
114            <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintByName">source&nbsp;code</a></span>
115
116          </td>
117        </tr>
118      </table>
119
120    </td>
121  </tr>
122<tr>
123    <td width="15%" align="right" valign="top" class="summary">
124      <span class="summary-type">&nbsp;</span>
125    </td><td class="summary">
126      <table width="100%" cellpadding="0" cellspacing="0" border="0">
127        <tr>
128          <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>,
129        <span class="summary-sig-arg">name</span>)</span><br />
130      Get pretty printed object prototype from the schema name.</td>
131          <td align="right" valign="top">
132            <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.prettyPrintByName">source&nbsp;code</a></span>
133
134          </td>
135        </tr>
136      </table>
137
138    </td>
139  </tr>
140<tr class="private">
141    <td width="15%" align="right" valign="top" class="summary">
142      <span class="summary-type">&nbsp;</span>
143    </td><td class="summary">
144      <table width="100%" cellpadding="0" cellspacing="0" border="0">
145        <tr>
146          <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">*args</span>,
147        <span class="summary-sig-arg">**kwargs</span>)</span><br />
148      Get pretty printed object prototype of schema.</td>
149          <td align="right" valign="top">
150            <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintSchema">source&nbsp;code</a></span>
151
152          </td>
153        </tr>
154      </table>
155
156    </td>
157  </tr>
158<tr>
159    <td width="15%" align="right" valign="top" class="summary">
160      <span class="summary-type">&nbsp;</span>
161    </td><td class="summary">
162      <table width="100%" cellpadding="0" cellspacing="0" border="0">
163        <tr>
164          <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>,
165        <span class="summary-sig-arg">schema</span>)</span><br />
166      Get pretty printed object prototype of schema.</td>
167          <td align="right" valign="top">
168            <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.prettyPrintSchema">source&nbsp;code</a></span>
169
170          </td>
171        </tr>
172      </table>
173
174    </td>
175  </tr>
176<tr>
177    <td width="15%" align="right" valign="top" class="summary">
178      <span class="summary-type">&nbsp;</span>
179    </td><td class="summary">
180      <table width="100%" cellpadding="0" cellspacing="0" border="0">
181        <tr>
182          <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>,
183        <span class="summary-sig-arg">name</span>,
184        <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</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="googleapiclient.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="googleapiclient.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>
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>
297  </h3>
298  </td><td align="right" valign="top"
299    ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintByName">source&nbsp;code</a></span>&nbsp;
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">
317    <dt>Decorators:</dt>
318    <dd><ul class="nomargin-top">
319        <li><code>@util.positional(2)</code></li>
320    </ul></dd>
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="googleapiclient.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>
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>
363  </h3>
364  </td><td align="right" valign="top"
365    ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintSchema">source&nbsp;code</a></span>&nbsp;
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">
383    <dt>Decorators:</dt>
384    <dd><ul class="nomargin-top">
385        <li><code>@util.positional(2)</code></li>
386    </ul></dd>
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="googleapiclient.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>,
429        <span class="sig-arg">default</span>=<span class="sig-default">None</span>)</span>
430  </h3>
431  </td><td align="right" valign="top"
432    ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.get">source&nbsp;code</a></span>&nbsp;
433    </td>
434  </tr></table>
435
436  <pre class="literalblock">
437Get deserialized JSON schema from the schema name.
438
439Args:
440  name: string, Schema name.
441  default: object, return value if name not found.
442
443</pre>
444  <dl class="fields">
445  </dl>
446</td></tr></table>
447</div>
448<br />
449<!-- ==================== NAVIGATION BAR ==================== -->
450<table class="navbar" border="0" width="100%" cellpadding="0"
451       bgcolor="#a0c0ff" cellspacing="0">
452  <tr valign="middle">
453  <!-- Home link -->
454      <th>&nbsp;&nbsp;&nbsp;<a
455        href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
456
457  <!-- Tree link -->
458      <th>&nbsp;&nbsp;&nbsp;<a
459        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
460
461  <!-- Index link -->
462      <th>&nbsp;&nbsp;&nbsp;<a
463        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
464
465  <!-- Help link -->
466      <th>&nbsp;&nbsp;&nbsp;<a
467        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
468
469      <th class="navbar" width="100%"></th>
470  </tr>
471</table>
472<table border="0" cellpadding="0" cellspacing="0" width="100%%">
473  <tr>
474    <td align="left" class="footer">
475    Generated by Epydoc 3.0.1 on Fri Oct  2 20:46:22 2020
476    </td>
477    <td align="right" class="footer">
478      <a target="mainFrame" href="http://epydoc.sourceforge.net"
479        >http://epydoc.sourceforge.net</a>
480    </td>
481  </tr>
482</table>
483
484<script type="text/javascript">
485  <!--
486  // Private objects are initially displayed (because if
487  // javascript is turned off then we want them to be
488  // visible); but by default, we want to hide them.  So hide
489  // them unless we have a cookie that says to show them.
490  checkCookie();
491  // -->
492</script>
493</body>
494</html>
495