Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d50cd6883f37e19a26fabe3af6a75d407146520 / . / docs / epy / apiclient.discovery.Resource-class.html
blob: 5354d101cb258560490385c92d64d8481c089577 [file] [log] [blame]
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[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.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
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.discovery-module.html">Module&nbsp;discovery</a> ::
39 Class&nbsp;Resource
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.discovery.Resource-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 Resource</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_apiclien_3" name="uml_class_diagram_for_apiclien_3">
59<area shape="rect" id="node2" href="apiclient.discovery.Resource-class.html#__init__" title="Build a Resource from the API description." alt="" coords="17,39,607,57"/>
60<area shape="rect" id="node2" href="apiclient.discovery.Resource-class.html#__getstate__" title="Trim the state down to something that can be pickled." alt="" coords="17,57,607,76"/>
61<area shape="rect" id="node2" href="apiclient.discovery.Resource-class.html#__setstate__" title="Reconstitute the state of the object from being pickled." alt="" coords="17,76,607,95"/>
62<area shape="rect" id="node1" href="apiclient.discovery.Resource-class.html" title="A class for interacting with a resource." alt="" coords="5,6,619,101"/>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]63</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]64 <img src="uml_class_diagram_for_apiclien_3.gif" alt='' usemap="#uml_class_diagram_for_apiclien_3" ismap="ismap" class="graph-without-title" />
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]65</center>
66</center>
67<hr />
68<pre class="literalblock">
69A class for interacting with a resource.
70
71</pre>
72
73<!-- ==================== INSTANCE METHODS ==================== -->
74<a name="section-InstanceMethods"></a>
75<table class="summary" border="1" cellpadding="3"
76 cellspacing="0" width="100%" bgcolor="white">
77<tr bgcolor="#70b0f0" class="table-header">
78 <td colspan="2" class="table-header">
79 <table border="0" cellpadding="0" cellspacing="0" width="100%">
80 <tr valign="top">
81 <td align="left"><span class="table-header">Instance Methods</span></td>
82 <td align="right" valign="top"
83 ><span class="options">[<a href="#section-InstanceMethods"
84 class="privatelink" onclick="toggle_private();"
85 >hide private</a>]</span></td>
86 </tr>
87 </table>
88 </td>
89</tr>
90<tr>
91 <td width="15%" align="right" valign="top" class="summary">
92 <span class="summary-type">&nbsp;</span>
93 </td><td class="summary">
94 <table width="100%" cellpadding="0" cellspacing="0" border="0">
95 <tr>
96 <td><span class="summary-sig"><a href="apiclient.discovery.Resource-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
97 <span class="summary-sig-arg">http</span>,
98 <span class="summary-sig-arg">baseUrl</span>,
99 <span class="summary-sig-arg">model</span>,
100 <span class="summary-sig-arg">requestBuilder</span>,
101 <span class="summary-sig-arg">developerKey</span>,
102 <span class="summary-sig-arg">resourceDesc</span>,
103 <span class="summary-sig-arg">rootDesc</span>,
104 <span class="summary-sig-arg">schema</span>)</span><br />
105 Build a Resource from the API description.</td>
106 <td align="right" valign="top">
107 <span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource.__init__">source&nbsp;code</a></span>
108
109 </td>
110 </tr>
111 </table>
112
113 </td>
114 </tr>
115<tr class="private">
116 <td width="15%" align="right" valign="top" class="summary">
117 <span class="summary-type">&nbsp;</span>
118 </td><td class="summary">
119 <table width="100%" cellpadding="0" cellspacing="0" border="0">
120 <tr>
121 <td><span class="summary-sig"><a href="apiclient.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>,
122 <span class="summary-sig-arg">attr_name</span>,
123 <span class="summary-sig-arg">value</span>)</span><br />
124 Sets an instance attribute and tracks it in a list of dynamic attributes.</td>
125 <td align="right" valign="top">
126 <span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource._set_dynamic_attr">source&nbsp;code</a></span>
127
128 </td>
129 </tr>
130 </table>
131
132 </td>
133 </tr>
134<tr>
135 <td width="15%" align="right" valign="top" class="summary">
136 <span class="summary-type">&nbsp;</span>
137 </td><td class="summary">
138 <table width="100%" cellpadding="0" cellspacing="0" border="0">
139 <tr>
140 <td><span class="summary-sig"><a href="apiclient.discovery.Resource-class.html#__getstate__" class="summary-sig-name">__getstate__</a>(<span class="summary-sig-arg">self</span>)</span><br />
141 Trim the state down to something that can be pickled.</td>
142 <td align="right" valign="top">
143 <span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource.__getstate__">source&nbsp;code</a></span>
144
145 </td>
146 </tr>
147 </table>
148
149 </td>
150 </tr>
151<tr>
152 <td width="15%" align="right" valign="top" class="summary">
153 <span class="summary-type">&nbsp;</span>
154 </td><td class="summary">
155 <table width="100%" cellpadding="0" cellspacing="0" border="0">
156 <tr>
157 <td><span class="summary-sig"><a href="apiclient.discovery.Resource-class.html#__setstate__" class="summary-sig-name">__setstate__</a>(<span class="summary-sig-arg">self</span>,
158 <span class="summary-sig-arg">state</span>)</span><br />
159 Reconstitute the state of the object from being pickled.</td>
160 <td align="right" valign="top">
161 <span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource.__setstate__">source&nbsp;code</a></span>
162
163 </td>
164 </tr>
165 </table>
166
167 </td>
168 </tr>
169<tr class="private">
170 <td width="15%" align="right" valign="top" class="summary">
171 <span class="summary-type">&nbsp;</span>
172 </td><td class="summary">
173 <table width="100%" cellpadding="0" cellspacing="0" border="0">
174 <tr>
175 <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>
176 <td align="right" valign="top">
177 <span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource._set_service_methods">source&nbsp;code</a></span>
178
179 </td>
180 </tr>
181 </table>
182
183 </td>
184 </tr>
185<tr class="private">
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 name="_add_basic_methods"></a><span class="summary-sig-name">_add_basic_methods</span>(<span class="summary-sig-arg">self</span>,
192 <span class="summary-sig-arg">resourceDesc</span>,
193 <span class="summary-sig-arg">rootDesc</span>,
194 <span class="summary-sig-arg">schema</span>)</span></td>
195 <td align="right" valign="top">
196 <span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource._add_basic_methods">source&nbsp;code</a></span>
197
198 </td>
199 </tr>
200 </table>
201
202 </td>
203 </tr>
204<tr class="private">
205 <td width="15%" align="right" valign="top" class="summary">
206 <span class="summary-type">&nbsp;</span>
207 </td><td class="summary">
208 <table width="100%" cellpadding="0" cellspacing="0" border="0">
209 <tr>
210 <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>,
211 <span class="summary-sig-arg">resourceDesc</span>,
212 <span class="summary-sig-arg">rootDesc</span>,
213 <span class="summary-sig-arg">schema</span>)</span></td>
214 <td align="right" valign="top">
215 <span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource._add_nested_resources">source&nbsp;code</a></span>
216
217 </td>
218 </tr>
219 </table>
220
221 </td>
222 </tr>
223<tr class="private">
224 <td width="15%" align="right" valign="top" class="summary">
225 <span class="summary-type">&nbsp;</span>
226 </td><td class="summary">
227 <table width="100%" cellpadding="0" cellspacing="0" border="0">
228 <tr>
229 <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>,
230 <span class="summary-sig-arg">resourceDesc</span>,
231 <span class="summary-sig-arg">schema</span>)</span></td>
232 <td align="right" valign="top">
233 <span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource._add_next_methods">source&nbsp;code</a></span>
234
235 </td>
236 </tr>
237 </table>
238
239 </td>
240 </tr>
241 <tr>
242 <td colspan="2" class="summary">
243 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
244 <code>__delattr__</code>,
245 <code>__format__</code>,
246 <code>__getattribute__</code>,
247 <code>__hash__</code>,
248 <code>__new__</code>,
249 <code>__reduce__</code>,
250 <code>__reduce_ex__</code>,
251 <code>__repr__</code>,
252 <code>__setattr__</code>,
253 <code>__sizeof__</code>,
254 <code>__str__</code>,
255 <code>__subclasshook__</code>
256 </p>
257 </td>
258 </tr>
259</table>
260<!-- ==================== PROPERTIES ==================== -->
261<a name="section-Properties"></a>
262<table class="summary" border="1" cellpadding="3"
263 cellspacing="0" width="100%" bgcolor="white">
264<tr bgcolor="#70b0f0" class="table-header">
265 <td colspan="2" class="table-header">
266 <table border="0" cellpadding="0" cellspacing="0" width="100%">
267 <tr valign="top">
268 <td align="left"><span class="table-header">Properties</span></td>
269 <td align="right" valign="top"
270 ><span class="options">[<a href="#section-Properties"
271 class="privatelink" onclick="toggle_private();"
272 >hide private</a>]</span></td>
273 </tr>
274 </table>
275 </td>
276</tr>
277 <tr>
278 <td colspan="2" class="summary">
279 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
280 <code>__class__</code>
281 </p>
282 </td>
283 </tr>
284</table>
285<!-- ==================== METHOD DETAILS ==================== -->
286<a name="section-MethodDetails"></a>
287<table class="details" border="1" cellpadding="3"
288 cellspacing="0" width="100%" bgcolor="white">
289<tr bgcolor="#70b0f0" class="table-header">
290 <td colspan="2" class="table-header">
291 <table border="0" cellpadding="0" cellspacing="0" width="100%">
292 <tr valign="top">
293 <td align="left"><span class="table-header">Method Details</span></td>
294 <td align="right" valign="top"
295 ><span class="options">[<a href="#section-MethodDetails"
296 class="privatelink" onclick="toggle_private();"
297 >hide private</a>]</span></td>
298 </tr>
299 </table>
300 </td>
301</tr>
302</table>
303<a name="__init__"></a>
304<div>
305<table class="details" border="1" cellpadding="3"
306 cellspacing="0" width="100%" bgcolor="white">
307<tr><td>
308 <table width="100%" cellpadding="0" cellspacing="0" border="0">
309 <tr valign="top"><td>
310 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
311 <span class="sig-arg">http</span>,
312 <span class="sig-arg">baseUrl</span>,
313 <span class="sig-arg">model</span>,
314 <span class="sig-arg">requestBuilder</span>,
315 <span class="sig-arg">developerKey</span>,
316 <span class="sig-arg">resourceDesc</span>,
317 <span class="sig-arg">rootDesc</span>,
318 <span class="sig-arg">schema</span>)</span>
319 <br /><em class="fname">(Constructor)</em>
320 </h3>
321 </td><td align="right" valign="top"
322 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource.__init__">source&nbsp;code</a></span>&nbsp;
323 </td>
324 </tr></table>
325
326 <pre class="literalblock">
327Build a Resource from the API description.
328
329Args:
330 http: httplib2.Http, Object to make http requests with.
331 baseUrl: string, base URL for the API. All requests are relative to this
332 URI.
333 model: apiclient.Model, converts to and from the wire format.
334 requestBuilder: class or callable that instantiates an
335 apiclient.HttpRequest object.
336 developerKey: string, key obtained from
337 https://code.google.com/apis/console
338 resourceDesc: object, section of deserialized discovery document that
339 describes a resource. Note that the top level discovery document
340 is considered a resource.
341 rootDesc: object, the entire deserialized discovery document.
342 schema: object, mapping of schema names to schema descriptions.
343
344</pre>
345 <dl class="fields">
346 <dt>Overrides:
347 object.__init__
348 </dt>
349 </dl>
350</td></tr></table>
351</div>
352<a name="_set_dynamic_attr"></a>
353<div class="private">
354<table class="details" border="1" cellpadding="3"
355 cellspacing="0" width="100%" bgcolor="white">
356<tr><td>
357 <table width="100%" cellpadding="0" cellspacing="0" border="0">
358 <tr valign="top"><td>
359 <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_dynamic_attr</span>(<span class="sig-arg">self</span>,
360 <span class="sig-arg">attr_name</span>,
361 <span class="sig-arg">value</span>)</span>
362 </h3>
363 </td><td align="right" valign="top"
364 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource._set_dynamic_attr">source&nbsp;code</a></span>&nbsp;
365 </td>
366 </tr></table>
367
368 <pre class="literalblock">
369Sets an instance attribute and tracks it in a list of dynamic attributes.
370
371Args:
372 attr_name: string; The name of the attribute to be set
373 value: The value being set on the object and tracked in the dynamic cache.
374
375</pre>
376 <dl class="fields">
377 </dl>
378</td></tr></table>
379</div>
380<a name="__getstate__"></a>
381<div>
382<table class="details" border="1" cellpadding="3"
383 cellspacing="0" width="100%" bgcolor="white">
384<tr><td>
385 <table width="100%" cellpadding="0" cellspacing="0" border="0">
386 <tr valign="top"><td>
387 <h3 class="epydoc"><span class="sig"><span class="sig-name">__getstate__</span>(<span class="sig-arg">self</span>)</span>
388 </h3>
389 </td><td align="right" valign="top"
390 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource.__getstate__">source&nbsp;code</a></span>&nbsp;
391 </td>
392 </tr></table>
393
394 <pre class="literalblock">
395Trim the state down to something that can be pickled.
396
397Uses the fact that the instance variable _dynamic_attrs holds attrs that
398will be wiped and restored on pickle serialization.
399
400</pre>
401 <dl class="fields">
402 </dl>
403</td></tr></table>
404</div>
405<a name="__setstate__"></a>
406<div>
407<table class="details" border="1" cellpadding="3"
408 cellspacing="0" width="100%" bgcolor="white">
409<tr><td>
410 <table width="100%" cellpadding="0" cellspacing="0" border="0">
411 <tr valign="top"><td>
412 <h3 class="epydoc"><span class="sig"><span class="sig-name">__setstate__</span>(<span class="sig-arg">self</span>,
413 <span class="sig-arg">state</span>)</span>
414 </h3>
415 </td><td align="right" valign="top"
416 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#Resource.__setstate__">source&nbsp;code</a></span>&nbsp;
417 </td>
418 </tr></table>
419
420 <pre class="literalblock">
421Reconstitute the state of the object from being pickled.
422
423Uses the fact that the instance variable _dynamic_attrs holds attrs that
424will be wiped and restored on pickle serialization.
425
426</pre>
427 <dl class="fields">
428 </dl>
429</td></tr></table>
430</div>
431<br />
432<!-- ==================== NAVIGATION BAR ==================== -->
433<table class="navbar" border="0" width="100%" cellpadding="0"
434 bgcolor="#a0c0ff" cellspacing="0">
435 <tr valign="middle">
436
437 <!-- Tree link -->
438 <th>&nbsp;&nbsp;&nbsp;<a
439 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
440
441 <!-- Index link -->
442 <th>&nbsp;&nbsp;&nbsp;<a
443 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
444
445 <!-- Help link -->
446 <th>&nbsp;&nbsp;&nbsp;<a
447 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
448
449 <th class="navbar" width="100%"></th>
450 </tr>
451</table>
452<table border="0" cellpadding="0" cellspacing="0" width="100%%">
453 <tr>
454 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]455 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:43 2013
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]456 </td>
457 <td align="right" class="footer">
458 <a target="mainFrame" href="http://epydoc.sourceforge.net"
459 >http://epydoc.sourceforge.net</a>
460 </td>
461 </tr>
462</table>
463
464<script type="text/javascript">
465 <!--
466 // Private objects are initially displayed (because if
467 // javascript is turned off then we want them to be
468 // visible); but by default, we want to hide them. So hide
469 // them unless we have a cookie that says to show them.
470 checkCookie();
471 // -->
472</script>
473</body>
474</html>