Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / epy / googleapiclient.schema.Schemas-class.html
blob: 839d7d8500f3a4b12a28d9612a539037c4962bb7 [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>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]61
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]62</center>
63<hr />
64<pre class="literalblock">
65Schemas for an API.
66
67</pre>
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">self</span>,
111 <span class="summary-sig-arg">name</span>,
112 <span class="summary-sig-arg">seen</span>=<span class="summary-sig-default">None</span>,
113 <span class="summary-sig-arg">dent</span>=<span class="summary-sig-default">0</span>)</span><br />
114 Get pretty printed object prototype from the schema name.</td>
115 <td align="right" valign="top">
116 <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintByName">source&nbsp;code</a></span>
117
118 </td>
119 </tr>
120 </table>
121
122 </td>
123 </tr>
124<tr>
125 <td width="15%" align="right" valign="top" class="summary">
126 <span class="summary-type">&nbsp;</span>
127 </td><td class="summary">
128 <table width="100%" cellpadding="0" cellspacing="0" border="0">
129 <tr>
130 <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>,
131 <span class="summary-sig-arg">name</span>)</span><br />
132 Get pretty printed object prototype from the schema name.</td>
133 <td align="right" valign="top">
134 <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.prettyPrintByName">source&nbsp;code</a></span>
135
136 </td>
137 </tr>
138 </table>
139
140 </td>
141 </tr>
142<tr class="private">
143 <td width="15%" align="right" valign="top" class="summary">
144 <span class="summary-type">&nbsp;</span>
145 </td><td class="summary">
146 <table width="100%" cellpadding="0" cellspacing="0" border="0">
147 <tr>
148 <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>,
149 <span class="summary-sig-arg">schema</span>,
150 <span class="summary-sig-arg">seen</span>=<span class="summary-sig-default">None</span>,
151 <span class="summary-sig-arg">dent</span>=<span class="summary-sig-default">0</span>)</span><br />
152 Get pretty printed object prototype of schema.</td>
153 <td align="right" valign="top">
154 <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintSchema">source&nbsp;code</a></span>
155
156 </td>
157 </tr>
158 </table>
159
160 </td>
161 </tr>
162<tr>
163 <td width="15%" align="right" valign="top" class="summary">
164 <span class="summary-type">&nbsp;</span>
165 </td><td class="summary">
166 <table width="100%" cellpadding="0" cellspacing="0" border="0">
167 <tr>
168 <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>,
169 <span class="summary-sig-arg">schema</span>)</span><br />
170 Get pretty printed object prototype of schema.</td>
171 <td align="right" valign="top">
172 <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.prettyPrintSchema">source&nbsp;code</a></span>
173
174 </td>
175 </tr>
176 </table>
177
178 </td>
179 </tr>
180<tr>
181 <td width="15%" align="right" valign="top" class="summary">
182 <span class="summary-type">&nbsp;</span>
183 </td><td class="summary">
184 <table width="100%" cellpadding="0" cellspacing="0" border="0">
185 <tr>
186 <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>,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]187 <span class="summary-sig-arg">name</span>,
188 <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]189 Get deserialized JSON schema from the schema name.</td>
190 <td align="right" valign="top">
191 <span class="codelink"><a href="googleapiclient.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="googleapiclient.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>
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>
303 </h3>
304 </td><td align="right" valign="top"
305 ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintByName">source&nbsp;code</a></span>&nbsp;
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">
323 <dt>Decorators:</dt>
324 <dd><ul class="nomargin-top">
325 <li><code>@util.positional(2)</code></li>
326 </ul></dd>
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="googleapiclient.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="googleapiclient.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 <dt>Decorators:</dt>
392 <dd><ul class="nomargin-top">
393 <li><code>@util.positional(2)</code></li>
394 </ul></dd>
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="googleapiclient.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>,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]436 <span class="sig-arg">name</span>,
437 <span class="sig-arg">default</span>=<span class="sig-default">None</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]438 </h3>
439 </td><td align="right" valign="top"
440 ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.get">source&nbsp;code</a></span>&nbsp;
441 </td>
442 </tr></table>
443
444 <pre class="literalblock">
445Get deserialized JSON schema from the schema name.
446
447Args:
448 name: string, Schema name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]449 default: object, return value if name not found.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]450
451</pre>
452 <dl class="fields">
453 </dl>
454</td></tr></table>
455</div>
456<br />
457<!-- ==================== NAVIGATION BAR ==================== -->
458<table class="navbar" border="0" width="100%" cellpadding="0"
459 bgcolor="#a0c0ff" cellspacing="0">
460 <tr valign="middle">
461 <!-- Home link -->
462 <th>&nbsp;&nbsp;&nbsp;<a
463 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
464
465 <!-- Tree link -->
466 <th>&nbsp;&nbsp;&nbsp;<a
467 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
468
469 <!-- Index link -->
470 <th>&nbsp;&nbsp;&nbsp;<a
471 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
472
473 <!-- Help link -->
474 <th>&nbsp;&nbsp;&nbsp;<a
475 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
476
477 <th class="navbar" width="100%"></th>
478 </tr>
479</table>
480<table border="0" cellpadding="0" cellspacing="0" width="100%%">
481 <tr>
482 <td align="left" class="footer">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]483 Generated by Epydoc 3.0.1 on Mon Jun 5 13:38:40 2017
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]484 </td>
485 <td align="right" class="footer">
486 <a target="mainFrame" href="http://epydoc.sourceforge.net"
487 >http://epydoc.sourceforge.net</a>
488 </td>
489 </tr>
490</table>
491
492<script type="text/javascript">
493 <!--
494 // Private objects are initially displayed (because if
495 // javascript is turned off then we want them to be
496 // visible); but by default, we want to hide them. So hide
497 // them unless we have a cookie that says to show them.
498 checkCookie();
499 // -->
500</script>
501</body>
502</html>