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