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.discovery.Resource</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.discovery-module.html">Module discovery</a> :: 42 Class Resource 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.discovery.Resource-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 Resource</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource">source code</a></span></p> 60<pre class="base-tree"> 61object --+ 62 | 63 <strong class="uidshort">Resource</strong> 64</pre> 65 66<hr /> 67<p>A class for interacting with a resource.</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"> </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.discovery.Resource-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, 93 <span class="summary-sig-arg">http</span>, 94 <span class="summary-sig-arg">baseUrl</span>, 95 <span class="summary-sig-arg">model</span>, 96 <span class="summary-sig-arg">requestBuilder</span>, 97 <span class="summary-sig-arg">developerKey</span>, 98 <span class="summary-sig-arg">resourceDesc</span>, 99 <span class="summary-sig-arg">rootDesc</span>, 100 <span class="summary-sig-arg">schema</span>)</span><br /> 101 Build a Resource from the API description.</td> 102 <td align="right" valign="top"> 103 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.__init__">source code</a></span> 104 105 </td> 106 </tr> 107 </table> 108 109 </td> 110 </tr> 111<tr class="private"> 112 <td width="15%" align="right" valign="top" class="summary"> 113 <span class="summary-type"> </span> 114 </td><td class="summary"> 115 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 116 <tr> 117 <td><span class="summary-sig"><a href="googleapiclient.discovery.Resource-class.html#_set_dynamic_attr" class="summary-sig-name" onclick="show_private();">_set_dynamic_attr</a>(<span class="summary-sig-arg">self</span>, 118 <span class="summary-sig-arg">attr_name</span>, 119 <span class="summary-sig-arg">value</span>)</span><br /> 120 Sets an instance attribute and tracks it in a list of dynamic attributes.</td> 121 <td align="right" valign="top"> 122 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource._set_dynamic_attr">source code</a></span> 123 124 </td> 125 </tr> 126 </table> 127 128 </td> 129 </tr> 130<tr> 131 <td width="15%" align="right" valign="top" class="summary"> 132 <span class="summary-type"> </span> 133 </td><td class="summary"> 134 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 135 <tr> 136 <td><span class="summary-sig"><a href="googleapiclient.discovery.Resource-class.html#__getstate__" class="summary-sig-name">__getstate__</a>(<span class="summary-sig-arg">self</span>)</span><br /> 137 Trim the state down to something that can be pickled.</td> 138 <td align="right" valign="top"> 139 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.__getstate__">source code</a></span> 140 141 </td> 142 </tr> 143 </table> 144 145 </td> 146 </tr> 147<tr> 148 <td width="15%" align="right" valign="top" class="summary"> 149 <span class="summary-type"> </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="googleapiclient.discovery.Resource-class.html#__setstate__" class="summary-sig-name">__setstate__</a>(<span class="summary-sig-arg">self</span>, 154 <span class="summary-sig-arg">state</span>)</span><br /> 155 Reconstitute the state of the object from being pickled.</td> 156 <td align="right" valign="top"> 157 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.__setstate__">source code</a></span> 158 159 </td> 160 </tr> 161 </table> 162 163 </td> 164 </tr> 165<tr> 166 <td width="15%" align="right" valign="top" class="summary"> 167 <span class="summary-type"> </span> 168 </td><td class="summary"> 169 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 170 <tr> 171 <td><span class="summary-sig"><a name="__enter__"></a><span class="summary-sig-name">__enter__</span>(<span class="summary-sig-arg">self</span>)</span></td> 172 <td align="right" valign="top"> 173 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.__enter__">source code</a></span> 174 175 </td> 176 </tr> 177 </table> 178 179 </td> 180 </tr> 181<tr> 182 <td width="15%" align="right" valign="top" class="summary"> 183 <span class="summary-type"> </span> 184 </td><td class="summary"> 185 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 186 <tr> 187 <td><span class="summary-sig"><a name="__exit__"></a><span class="summary-sig-name">__exit__</span>(<span class="summary-sig-arg">self</span>, 188 <span class="summary-sig-arg">exc_type</span>, 189 <span class="summary-sig-arg">exc</span>, 190 <span class="summary-sig-arg">exc_tb</span>)</span></td> 191 <td align="right" valign="top"> 192 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.__exit__">source code</a></span> 193 194 </td> 195 </tr> 196 </table> 197 198 </td> 199 </tr> 200<tr> 201 <td width="15%" align="right" valign="top" class="summary"> 202 <span class="summary-type"> </span> 203 </td><td class="summary"> 204 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 205 <tr> 206 <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span><br /> 207 Close httplib2 connections.</td> 208 <td align="right" valign="top"> 209 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.close">source code</a></span> 210 211 </td> 212 </tr> 213 </table> 214 215 </td> 216 </tr> 217<tr class="private"> 218 <td width="15%" align="right" valign="top" class="summary"> 219 <span class="summary-type"> </span> 220 </td><td class="summary"> 221 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 222 <tr> 223 <td><span class="summary-sig"><a name="_set_service_methods"></a><span class="summary-sig-name">_set_service_methods</span>(<span class="summary-sig-arg">self</span>)</span></td> 224 <td align="right" valign="top"> 225 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource._set_service_methods">source code</a></span> 226 227 </td> 228 </tr> 229 </table> 230 231 </td> 232 </tr> 233<tr class="private"> 234 <td width="15%" align="right" valign="top" class="summary"> 235 <span class="summary-type"> </span> 236 </td><td class="summary"> 237 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 238 <tr> 239 <td><span class="summary-sig"><a name="_add_basic_methods"></a><span class="summary-sig-name">_add_basic_methods</span>(<span class="summary-sig-arg">self</span>, 240 <span class="summary-sig-arg">resourceDesc</span>, 241 <span class="summary-sig-arg">rootDesc</span>, 242 <span class="summary-sig-arg">schema</span>)</span></td> 243 <td align="right" valign="top"> 244 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource._add_basic_methods">source code</a></span> 245 246 </td> 247 </tr> 248 </table> 249 250 </td> 251 </tr> 252<tr class="private"> 253 <td width="15%" align="right" valign="top" class="summary"> 254 <span class="summary-type"> </span> 255 </td><td class="summary"> 256 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 257 <tr> 258 <td><span class="summary-sig"><a name="_add_nested_resources"></a><span class="summary-sig-name">_add_nested_resources</span>(<span class="summary-sig-arg">self</span>, 259 <span class="summary-sig-arg">resourceDesc</span>, 260 <span class="summary-sig-arg">rootDesc</span>, 261 <span class="summary-sig-arg">schema</span>)</span></td> 262 <td align="right" valign="top"> 263 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource._add_nested_resources">source code</a></span> 264 265 </td> 266 </tr> 267 </table> 268 269 </td> 270 </tr> 271<tr class="private"> 272 <td width="15%" align="right" valign="top" class="summary"> 273 <span class="summary-type"> </span> 274 </td><td class="summary"> 275 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 276 <tr> 277 <td><span class="summary-sig"><a name="_add_next_methods"></a><span class="summary-sig-name">_add_next_methods</span>(<span class="summary-sig-arg">self</span>, 278 <span class="summary-sig-arg">resourceDesc</span>, 279 <span class="summary-sig-arg">schema</span>)</span></td> 280 <td align="right" valign="top"> 281 <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource._add_next_methods">source code</a></span> 282 283 </td> 284 </tr> 285 </table> 286 287 </td> 288 </tr> 289 <tr> 290 <td colspan="2" class="summary"> 291 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: 292 <code>__delattr__</code>, 293 <code>__format__</code>, 294 <code>__getattribute__</code>, 295 <code>__hash__</code>, 296 <code>__new__</code>, 297 <code>__reduce__</code>, 298 <code>__reduce_ex__</code>, 299 <code>__repr__</code>, 300 <code>__setattr__</code>, 301 <code>__sizeof__</code>, 302 <code>__str__</code>, 303 <code>__subclasshook__</code> 304 </p> 305 </td> 306 </tr> 307</table> 308<!-- ==================== PROPERTIES ==================== --> 309<a name="section-Properties"></a> 310<table class="summary" border="1" cellpadding="3" 311 cellspacing="0" width="100%" bgcolor="white"> 312<tr bgcolor="#70b0f0" class="table-header"> 313 <td colspan="2" class="table-header"> 314 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 315 <tr valign="top"> 316 <td align="left"><span class="table-header">Properties</span></td> 317 <td align="right" valign="top" 318 ><span class="options">[<a href="#section-Properties" 319 class="privatelink" onclick="toggle_private();" 320 >hide private</a>]</span></td> 321 </tr> 322 </table> 323 </td> 324</tr> 325 <tr> 326 <td colspan="2" class="summary"> 327 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: 328 <code>__class__</code> 329 </p> 330 </td> 331 </tr> 332</table> 333<!-- ==================== METHOD DETAILS ==================== --> 334<a name="section-MethodDetails"></a> 335<table class="details" border="1" cellpadding="3" 336 cellspacing="0" width="100%" bgcolor="white"> 337<tr bgcolor="#70b0f0" class="table-header"> 338 <td colspan="2" class="table-header"> 339 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 340 <tr valign="top"> 341 <td align="left"><span class="table-header">Method Details</span></td> 342 <td align="right" valign="top" 343 ><span class="options">[<a href="#section-MethodDetails" 344 class="privatelink" onclick="toggle_private();" 345 >hide private</a>]</span></td> 346 </tr> 347 </table> 348 </td> 349</tr> 350</table> 351<a name="__init__"></a> 352<div> 353<table class="details" border="1" cellpadding="3" 354 cellspacing="0" width="100%" bgcolor="white"> 355<tr><td> 356 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 357 <tr valign="top"><td> 358 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, 359 <span class="sig-arg">http</span>, 360 <span class="sig-arg">baseUrl</span>, 361 <span class="sig-arg">model</span>, 362 <span class="sig-arg">requestBuilder</span>, 363 <span class="sig-arg">developerKey</span>, 364 <span class="sig-arg">resourceDesc</span>, 365 <span class="sig-arg">rootDesc</span>, 366 <span class="sig-arg">schema</span>)</span> 367 <br /><em class="fname">(Constructor)</em> 368 </h3> 369 </td><td align="right" valign="top" 370 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.__init__">source code</a></span> 371 </td> 372 </tr></table> 373 374 <pre class="literalblock"> 375Build a Resource from the API description. 376 377Args: 378 http: httplib2.Http, Object to make http requests with. 379 baseUrl: string, base URL for the API. All requests are relative to this 380 URI. 381 model: googleapiclient.Model, converts to and from the wire format. 382 requestBuilder: class or callable that instantiates an 383 googleapiclient.HttpRequest object. 384 developerKey: string, key obtained from 385 https://code.google.com/apis/console 386 resourceDesc: object, section of deserialized discovery document that 387 describes a resource. Note that the top level discovery document 388 is considered a resource. 389 rootDesc: object, the entire deserialized discovery document. 390 schema: object, mapping of schema names to schema descriptions. 391 392</pre> 393 <dl class="fields"> 394 <dt>Overrides: 395 object.__init__ 396 </dt> 397 </dl> 398</td></tr></table> 399</div> 400<a name="_set_dynamic_attr"></a> 401<div class="private"> 402<table class="details" border="1" cellpadding="3" 403 cellspacing="0" width="100%" bgcolor="white"> 404<tr><td> 405 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 406 <tr valign="top"><td> 407 <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_dynamic_attr</span>(<span class="sig-arg">self</span>, 408 <span class="sig-arg">attr_name</span>, 409 <span class="sig-arg">value</span>)</span> 410 </h3> 411 </td><td align="right" valign="top" 412 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource._set_dynamic_attr">source code</a></span> 413 </td> 414 </tr></table> 415 416 <pre class="literalblock"> 417Sets an instance attribute and tracks it in a list of dynamic attributes. 418 419Args: 420 attr_name: string; The name of the attribute to be set 421 value: The value being set on the object and tracked in the dynamic cache. 422 423</pre> 424 <dl class="fields"> 425 </dl> 426</td></tr></table> 427</div> 428<a name="__getstate__"></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">__getstate__</span>(<span class="sig-arg">self</span>)</span> 436 </h3> 437 </td><td align="right" valign="top" 438 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.__getstate__">source code</a></span> 439 </td> 440 </tr></table> 441 442 <p>Trim the state down to something that can be pickled.</p> 443 <p>Uses the fact that the instance variable _dynamic_attrs holds attrs 444 that will be wiped and restored on pickle serialization.</p> 445 <dl class="fields"> 446 </dl> 447</td></tr></table> 448</div> 449<a name="__setstate__"></a> 450<div> 451<table class="details" border="1" cellpadding="3" 452 cellspacing="0" width="100%" bgcolor="white"> 453<tr><td> 454 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 455 <tr valign="top"><td> 456 <h3 class="epydoc"><span class="sig"><span class="sig-name">__setstate__</span>(<span class="sig-arg">self</span>, 457 <span class="sig-arg">state</span>)</span> 458 </h3> 459 </td><td align="right" valign="top" 460 ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#Resource.__setstate__">source code</a></span> 461 </td> 462 </tr></table> 463 464 <p>Reconstitute the state of the object from being pickled.</p> 465 <p>Uses the fact that the instance variable _dynamic_attrs holds attrs 466 that will be wiped and restored on pickle serialization.</p> 467 <dl class="fields"> 468 </dl> 469</td></tr></table> 470</div> 471<br /> 472<!-- ==================== NAVIGATION BAR ==================== --> 473<table class="navbar" border="0" width="100%" cellpadding="0" 474 bgcolor="#a0c0ff" cellspacing="0"> 475 <tr valign="middle"> 476 <!-- Home link --> 477 <th> <a 478 href="googleapiclient-module.html">Home</a> </th> 479 480 <!-- Tree link --> 481 <th> <a 482 href="module-tree.html">Trees</a> </th> 483 484 <!-- Index link --> 485 <th> <a 486 href="identifier-index.html">Indices</a> </th> 487 488 <!-- Help link --> 489 <th> <a 490 href="help.html">Help</a> </th> 491 492 <th class="navbar" width="100%"></th> 493 </tr> 494</table> 495<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 496 <tr> 497 <td align="left" class="footer"> 498 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 499 </td> 500 <td align="right" class="footer"> 501 <a target="mainFrame" href="http://epydoc.sourceforge.net" 502 >http://epydoc.sourceforge.net</a> 503 </td> 504 </tr> 505</table> 506 507<script type="text/javascript"> 508 <!-- 509 // Private objects are initially displayed (because if 510 // javascript is turned off then we want them to be 511 // visible); but by default, we want to hide them. So hide 512 // them unless we have a cookie that says to show them. 513 checkCookie(); 514 // --> 515</script> 516</body> 517</html> 518