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> <a 19 href="googleapiclient-module.html">Home</a> </th> 20 21 <!-- Tree link --> 22 <th> <a 23 href="module-tree.html">Trees</a> </th> 24 25 <!-- Index link --> 26 <th> <a 27 href="identifier-index.html">Indices</a> </th> 28 29 <!-- Help link --> 30 <th> <a 31 href="help.html">Help</a> </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 googleapiclient</a> :: 41 <a href="googleapiclient.schema-module.html">Module schema</a> :: 42 Class 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 private</a>]</span></td></tr> 50 <tr><td align="right"><span class="options" 51 >[<a href="frames.html" target="_top">frames</a 52 >] | <a href="googleapiclient.schema.Schemas-class.html" 53 target="_top">no 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 code</a></span></p> 60<center> 61<center> <map id="uml_class_diagram_for_googleap_44" name="uml_class_diagram_for_googleap_44"> 62<area shape="rect" id="node1_4" href="googleapiclient.schema.Schemas-class.html#__init__" title="Constructor." alt="" coords="17,38,215,58"/> 63<area shape="rect" id="node1_5" href="googleapiclient.schema.Schemas-class.html#prettyPrintByName" title="Get pretty printed object prototype from the schema name." alt="" coords="17,58,215,78"/> 64<area shape="rect" id="node1_6" href="googleapiclient.schema.Schemas-class.html#prettyPrintSchema" title="Get pretty printed object prototype of schema." alt="" coords="17,78,215,98"/> 65<area shape="rect" id="node1_7" href="googleapiclient.schema.Schemas-class.html#get" title="Get deserialized JSON schema from the schema name." alt="" coords="17,98,215,118"/> 66<area shape="rect" id="node1" href="googleapiclient.schema.Schemas-class.html" title="Schemas for an API." alt="" coords="5,5,227,124"/> 67</map> 68 <img src="uml_class_diagram_for_googleap_44.gif" alt='' usemap="#uml_class_diagram_for_googleap_44" 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"> </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 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"> </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 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"> </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 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"> </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 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"> </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 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"> </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>, 196 <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>)</span><br /> 197 Get deserialized JSON schema from the schema name.</td> 198 <td align="right" valign="top"> 199 <span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.get">source code</a></span> 200 201 </td> 202 </tr> 203 </table> 204 205 </td> 206 </tr> 207 <tr> 208 <td colspan="2" class="summary"> 209 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: 210 <code>__delattr__</code>, 211 <code>__format__</code>, 212 <code>__getattribute__</code>, 213 <code>__hash__</code>, 214 <code>__new__</code>, 215 <code>__reduce__</code>, 216 <code>__reduce_ex__</code>, 217 <code>__repr__</code>, 218 <code>__setattr__</code>, 219 <code>__sizeof__</code>, 220 <code>__str__</code>, 221 <code>__subclasshook__</code> 222 </p> 223 </td> 224 </tr> 225</table> 226<!-- ==================== PROPERTIES ==================== --> 227<a name="section-Properties"></a> 228<table class="summary" border="1" cellpadding="3" 229 cellspacing="0" width="100%" bgcolor="white"> 230<tr bgcolor="#70b0f0" class="table-header"> 231 <td colspan="2" class="table-header"> 232 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 233 <tr valign="top"> 234 <td align="left"><span class="table-header">Properties</span></td> 235 <td align="right" valign="top" 236 ><span class="options">[<a href="#section-Properties" 237 class="privatelink" onclick="toggle_private();" 238 >hide private</a>]</span></td> 239 </tr> 240 </table> 241 </td> 242</tr> 243 <tr> 244 <td colspan="2" class="summary"> 245 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: 246 <code>__class__</code> 247 </p> 248 </td> 249 </tr> 250</table> 251<!-- ==================== METHOD DETAILS ==================== --> 252<a name="section-MethodDetails"></a> 253<table class="details" border="1" cellpadding="3" 254 cellspacing="0" width="100%" bgcolor="white"> 255<tr bgcolor="#70b0f0" class="table-header"> 256 <td colspan="2" class="table-header"> 257 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 258 <tr valign="top"> 259 <td align="left"><span class="table-header">Method Details</span></td> 260 <td align="right" valign="top" 261 ><span class="options">[<a href="#section-MethodDetails" 262 class="privatelink" onclick="toggle_private();" 263 >hide private</a>]</span></td> 264 </tr> 265 </table> 266 </td> 267</tr> 268</table> 269<a name="__init__"></a> 270<div> 271<table class="details" border="1" cellpadding="3" 272 cellspacing="0" width="100%" bgcolor="white"> 273<tr><td> 274 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 275 <tr valign="top"><td> 276 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, 277 <span class="sig-arg">discovery</span>)</span> 278 <br /><em class="fname">(Constructor)</em> 279 </h3> 280 </td><td align="right" valign="top" 281 ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.__init__">source code</a></span> 282 </td> 283 </tr></table> 284 285 <pre class="literalblock"> 286Constructor. 287 288Args: 289 discovery: object, Deserialized discovery document from which we pull 290 out the named schema. 291 292</pre> 293 <dl class="fields"> 294 <dt>Overrides: 295 object.__init__ 296 </dt> 297 </dl> 298</td></tr></table> 299</div> 300<a name="_prettyPrintByName"></a> 301<div class="private"> 302<table class="details" border="1" cellpadding="3" 303 cellspacing="0" width="100%" bgcolor="white"> 304<tr><td> 305 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 306 <tr valign="top"><td> 307 <h3 class="epydoc"><span class="sig"><span class="sig-name">_prettyPrintByName</span>(<span class="sig-arg">self</span>, 308 <span class="sig-arg">name</span>, 309 <span class="sig-arg">seen</span>=<span class="sig-default">None</span>, 310 <span class="sig-arg">dent</span>=<span class="sig-default">0</span>)</span> 311 </h3> 312 </td><td align="right" valign="top" 313 ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintByName">source code</a></span> 314 </td> 315 </tr></table> 316 317 <pre class="literalblock"> 318Get pretty printed object prototype from the schema name. 319 320Args: 321 name: string, Name of schema in the discovery document. 322 seen: list of string, Names of schema already seen. Used to handle 323 recursive definitions. 324 325Returns: 326 string, A string that contains a prototype object with 327 comments that conforms to the given schema. 328 329</pre> 330 <dl class="fields"> 331 <dt>Decorators:</dt> 332 <dd><ul class="nomargin-top"> 333 <li><code>@util.positional(2)</code></li> 334 </ul></dd> 335 </dl> 336</td></tr></table> 337</div> 338<a name="prettyPrintByName"></a> 339<div> 340<table class="details" border="1" cellpadding="3" 341 cellspacing="0" width="100%" bgcolor="white"> 342<tr><td> 343 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 344 <tr valign="top"><td> 345 <h3 class="epydoc"><span class="sig"><span class="sig-name">prettyPrintByName</span>(<span class="sig-arg">self</span>, 346 <span class="sig-arg">name</span>)</span> 347 </h3> 348 </td><td align="right" valign="top" 349 ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.prettyPrintByName">source code</a></span> 350 </td> 351 </tr></table> 352 353 <pre class="literalblock"> 354Get pretty printed object prototype from the schema name. 355 356Args: 357 name: string, Name of schema in the discovery document. 358 359Returns: 360 string, A string that contains a prototype object with 361 comments that conforms to the given schema. 362 363</pre> 364 <dl class="fields"> 365 </dl> 366</td></tr></table> 367</div> 368<a name="_prettyPrintSchema"></a> 369<div class="private"> 370<table class="details" border="1" cellpadding="3" 371 cellspacing="0" width="100%" bgcolor="white"> 372<tr><td> 373 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 374 <tr valign="top"><td> 375 <h3 class="epydoc"><span class="sig"><span class="sig-name">_prettyPrintSchema</span>(<span class="sig-arg">self</span>, 376 <span class="sig-arg">schema</span>, 377 <span class="sig-arg">seen</span>=<span class="sig-default">None</span>, 378 <span class="sig-arg">dent</span>=<span class="sig-default">0</span>)</span> 379 </h3> 380 </td><td align="right" valign="top" 381 ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas._prettyPrintSchema">source code</a></span> 382 </td> 383 </tr></table> 384 385 <pre class="literalblock"> 386Get pretty printed object prototype of schema. 387 388Args: 389 schema: object, Parsed JSON schema. 390 seen: list of string, Names of schema already seen. Used to handle 391 recursive definitions. 392 393Returns: 394 string, A string that contains a prototype object with 395 comments that conforms to the given schema. 396 397</pre> 398 <dl class="fields"> 399 <dt>Decorators:</dt> 400 <dd><ul class="nomargin-top"> 401 <li><code>@util.positional(2)</code></li> 402 </ul></dd> 403 </dl> 404</td></tr></table> 405</div> 406<a name="prettyPrintSchema"></a> 407<div> 408<table class="details" border="1" cellpadding="3" 409 cellspacing="0" width="100%" bgcolor="white"> 410<tr><td> 411 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 412 <tr valign="top"><td> 413 <h3 class="epydoc"><span class="sig"><span class="sig-name">prettyPrintSchema</span>(<span class="sig-arg">self</span>, 414 <span class="sig-arg">schema</span>)</span> 415 </h3> 416 </td><td align="right" valign="top" 417 ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.prettyPrintSchema">source code</a></span> 418 </td> 419 </tr></table> 420 421 <pre class="literalblock"> 422Get pretty printed object prototype of schema. 423 424Args: 425 schema: object, Parsed JSON schema. 426 427Returns: 428 string, A string that contains a prototype object with 429 comments that conforms to the given schema. 430 431</pre> 432 <dl class="fields"> 433 </dl> 434</td></tr></table> 435</div> 436<a name="get"></a> 437<div> 438<table class="details" border="1" cellpadding="3" 439 cellspacing="0" width="100%" bgcolor="white"> 440<tr><td> 441 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 442 <tr valign="top"><td> 443 <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>, 444 <span class="sig-arg">name</span>, 445 <span class="sig-arg">default</span>=<span class="sig-default">None</span>)</span> 446 </h3> 447 </td><td align="right" valign="top" 448 ><span class="codelink"><a href="googleapiclient.schema-pysrc.html#Schemas.get">source code</a></span> 449 </td> 450 </tr></table> 451 452 <pre class="literalblock"> 453Get deserialized JSON schema from the schema name. 454 455Args: 456 name: string, Schema name. 457 default: object, return value if name not found. 458 459</pre> 460 <dl class="fields"> 461 </dl> 462</td></tr></table> 463</div> 464<br /> 465<!-- ==================== NAVIGATION BAR ==================== --> 466<table class="navbar" border="0" width="100%" cellpadding="0" 467 bgcolor="#a0c0ff" cellspacing="0"> 468 <tr valign="middle"> 469 <!-- Home link --> 470 <th> <a 471 href="googleapiclient-module.html">Home</a> </th> 472 473 <!-- Tree link --> 474 <th> <a 475 href="module-tree.html">Trees</a> </th> 476 477 <!-- Index link --> 478 <th> <a 479 href="identifier-index.html">Indices</a> </th> 480 481 <!-- Help link --> 482 <th> <a 483 href="help.html">Help</a> </th> 484 485 <th class="navbar" width="100%"></th> 486 </tr> 487</table> 488<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 489 <tr> 490 <td align="left" class="footer"> 491 Generated by Epydoc 3.0.1 on Fri Jun 14 15:57:29 2019 492 </td> 493 <td align="right" class="footer"> 494 <a target="mainFrame" href="http://epydoc.sourceforge.net" 495 >http://epydoc.sourceforge.net</a> 496 </td> 497 </tr> 498</table> 499 500<script type="text/javascript"> 501 <!-- 502 // Private objects are initially displayed (because if 503 // javascript is turned off then we want them to be 504 // visible); but by default, we want to hide them. So hide 505 // them unless we have a cookie that says to show them. 506 checkCookie(); 507 // --> 508</script> 509</body> 510</html> 511
