Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d67010d98769c7f0b7792ce26b8ca7527dd3561c / . / docs / epy / apiclient.model.BaseModel-class.html
blob: e5ee1778a5169fb7ef5a1de751f36eba60120a36 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -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>apiclient.model.BaseModel</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.model-module.html">Module&nbsp;model</a> ::
39 Class&nbsp;BaseModel
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.model.BaseModel-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 BaseModel</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]58<center> <map id="class_hierarchy_for_basemodel" name="class_hierarchy_for_basemodel">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]59<area shape="rect" href="apiclient.model.BaseModel-class.html" title="BaseModel" alt="" coords="5,5,91,32"/>
60<area shape="rect" href="apiclient.model.Model-class.html" title="Model" alt="" coords="115,5,171,32"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]61</map>
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]62 <img src="class_hierarchy_for_basemodel.gif" alt='' usemap="#class_hierarchy_for_basemodel" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]63</center>
64</center>
65<hr />
66<pre class="literalblock">
67Base model class.
68
69Subclasses should provide implementations for the &quot;serialize&quot; and
70&quot;deserialize&quot; methods, as well as values for the following class attributes.
71
72Attributes:
73 accept: The value to use for the HTTP Accept header.
74 content_type: The value to use for the HTTP Content-type header.
75 no_content_response: The value to return when deserializing a 204 &quot;No
76 Content&quot; response.
77 alt_param: The value to supply as the &quot;alt&quot; query parameter for requests.
78
79</pre>
80
81<!-- ==================== INSTANCE METHODS ==================== -->
82<a name="section-InstanceMethods"></a>
83<table class="summary" border="1" cellpadding="3"
84 cellspacing="0" width="100%" bgcolor="white">
85<tr bgcolor="#70b0f0" class="table-header">
86 <td colspan="2" class="table-header">
87 <table border="0" cellpadding="0" cellspacing="0" width="100%">
88 <tr valign="top">
89 <td align="left"><span class="table-header">Instance Methods</span></td>
90 <td align="right" valign="top"
91 ><span class="options">[<a href="#section-InstanceMethods"
92 class="privatelink" onclick="toggle_private();"
93 >hide private</a>]</span></td>
94 </tr>
95 </table>
96 </td>
97</tr>
98<tr class="private">
99 <td width="15%" align="right" valign="top" class="summary">
100 <span class="summary-type">&nbsp;</span>
101 </td><td class="summary">
102 <table width="100%" cellpadding="0" cellspacing="0" border="0">
103 <tr>
104 <td><span class="summary-sig"><a name="_log_request"></a><span class="summary-sig-name">_log_request</span>(<span class="summary-sig-arg">self</span>,
105 <span class="summary-sig-arg">headers</span>,
106 <span class="summary-sig-arg">path_params</span>,
107 <span class="summary-sig-arg">query</span>,
108 <span class="summary-sig-arg">body</span>)</span><br />
109 Logs debugging information about the request if requested.</td>
110 <td align="right" valign="top">
111 <span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel._log_request">source&nbsp;code</a></span>
112
113 </td>
114 </tr>
115 </table>
116
117 </td>
118 </tr>
119<tr>
120 <td width="15%" align="right" valign="top" class="summary">
121 <span class="summary-type">&nbsp;</span>
122 </td><td class="summary">
123 <table width="100%" cellpadding="0" cellspacing="0" border="0">
124 <tr>
125 <td><span class="summary-sig"><a href="apiclient.model.BaseModel-class.html#request" class="summary-sig-name">request</a>(<span class="summary-sig-arg">self</span>,
126 <span class="summary-sig-arg">headers</span>,
127 <span class="summary-sig-arg">path_params</span>,
128 <span class="summary-sig-arg">query_params</span>,
129 <span class="summary-sig-arg">body_value</span>)</span><br />
130 Updates outgoing requests with a serialized body.</td>
131 <td align="right" valign="top">
132 <span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel.request">source&nbsp;code</a></span>
133
134 </td>
135 </tr>
136 </table>
137
138 </td>
139 </tr>
140<tr class="private">
141 <td width="15%" align="right" valign="top" class="summary">
142 <span class="summary-type">&nbsp;</span>
143 </td><td class="summary">
144 <table width="100%" cellpadding="0" cellspacing="0" border="0">
145 <tr>
146 <td><span class="summary-sig"><a href="apiclient.model.BaseModel-class.html#_build_query" class="summary-sig-name" onclick="show_private();">_build_query</a>(<span class="summary-sig-arg">self</span>,
147 <span class="summary-sig-arg">params</span>)</span><br />
148 Builds a query string.</td>
149 <td align="right" valign="top">
150 <span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel._build_query">source&nbsp;code</a></span>
151
152 </td>
153 </tr>
154 </table>
155
156 </td>
157 </tr>
158<tr class="private">
159 <td width="15%" align="right" valign="top" class="summary">
160 <span class="summary-type">&nbsp;</span>
161 </td><td class="summary">
162 <table width="100%" cellpadding="0" cellspacing="0" border="0">
163 <tr>
164 <td><span class="summary-sig"><a name="_log_response"></a><span class="summary-sig-name">_log_response</span>(<span class="summary-sig-arg">self</span>,
165 <span class="summary-sig-arg">resp</span>,
166 <span class="summary-sig-arg">content</span>)</span><br />
167 Logs debugging information about the response if requested.</td>
168 <td align="right" valign="top">
169 <span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel._log_response">source&nbsp;code</a></span>
170
171 </td>
172 </tr>
173 </table>
174
175 </td>
176 </tr>
177<tr>
178 <td width="15%" align="right" valign="top" class="summary">
179 <span class="summary-type">&nbsp;</span>
180 </td><td class="summary">
181 <table width="100%" cellpadding="0" cellspacing="0" border="0">
182 <tr>
183 <td><span class="summary-sig"><a href="apiclient.model.BaseModel-class.html#response" class="summary-sig-name">response</a>(<span class="summary-sig-arg">self</span>,
184 <span class="summary-sig-arg">resp</span>,
185 <span class="summary-sig-arg">content</span>)</span><br />
186 Convert the response wire format into a Python object.</td>
187 <td align="right" valign="top">
188 <span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel.response">source&nbsp;code</a></span>
189
190 </td>
191 </tr>
192 </table>
193
194 </td>
195 </tr>
196<tr>
197 <td width="15%" align="right" valign="top" class="summary">
198 <span class="summary-type">&nbsp;</span>
199 </td><td class="summary">
200 <table width="100%" cellpadding="0" cellspacing="0" border="0">
201 <tr>
202 <td><span class="summary-sig"><a href="apiclient.model.BaseModel-class.html#serialize" class="summary-sig-name">serialize</a>(<span class="summary-sig-arg">self</span>,
203 <span class="summary-sig-arg">body_value</span>)</span><br />
204 Perform the actual Python object serialization.</td>
205 <td align="right" valign="top">
206 <span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel.serialize">source&nbsp;code</a></span>
207
208 </td>
209 </tr>
210 </table>
211
212 </td>
213 </tr>
214<tr>
215 <td width="15%" align="right" valign="top" class="summary">
216 <span class="summary-type">&nbsp;</span>
217 </td><td class="summary">
218 <table width="100%" cellpadding="0" cellspacing="0" border="0">
219 <tr>
220 <td><span class="summary-sig"><a href="apiclient.model.BaseModel-class.html#deserialize" class="summary-sig-name">deserialize</a>(<span class="summary-sig-arg">self</span>,
221 <span class="summary-sig-arg">content</span>)</span><br />
222 Perform the actual deserialization from response string to Python
223object.</td>
224 <td align="right" valign="top">
225 <span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel.deserialize">source&nbsp;code</a></span>
226
227 </td>
228 </tr>
229 </table>
230
231 </td>
232 </tr>
233 <tr>
234 <td colspan="2" class="summary">
235 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
236 <code>__delattr__</code>,
237 <code>__format__</code>,
238 <code>__getattribute__</code>,
239 <code>__hash__</code>,
240 <code>__init__</code>,
241 <code>__new__</code>,
242 <code>__reduce__</code>,
243 <code>__reduce_ex__</code>,
244 <code>__repr__</code>,
245 <code>__setattr__</code>,
246 <code>__sizeof__</code>,
247 <code>__str__</code>,
248 <code>__subclasshook__</code>
249 </p>
250 </td>
251 </tr>
252</table>
253<!-- ==================== CLASS VARIABLES ==================== -->
254<a name="section-ClassVariables"></a>
255<table class="summary" border="1" cellpadding="3"
256 cellspacing="0" width="100%" bgcolor="white">
257<tr bgcolor="#70b0f0" class="table-header">
258 <td colspan="2" class="table-header">
259 <table border="0" cellpadding="0" cellspacing="0" width="100%">
260 <tr valign="top">
261 <td align="left"><span class="table-header">Class Variables</span></td>
262 <td align="right" valign="top"
263 ><span class="options">[<a href="#section-ClassVariables"
264 class="privatelink" onclick="toggle_private();"
265 >hide private</a>]</span></td>
266 </tr>
267 </table>
268 </td>
269</tr>
270<tr>
271 <td width="15%" align="right" valign="top" class="summary">
272 <span class="summary-type">&nbsp;</span>
273 </td><td class="summary">
274 <a name="accept"></a><span class="summary-name">accept</span> = <code title="None">None</code>
275 </td>
276 </tr>
277<tr>
278 <td width="15%" align="right" valign="top" class="summary">
279 <span class="summary-type">&nbsp;</span>
280 </td><td class="summary">
281 <a name="content_type"></a><span class="summary-name">content_type</span> = <code title="None">None</code>
282 </td>
283 </tr>
284<tr>
285 <td width="15%" align="right" valign="top" class="summary">
286 <span class="summary-type">&nbsp;</span>
287 </td><td class="summary">
288 <a name="no_content_response"></a><span class="summary-name">no_content_response</span> = <code title="None">None</code>
289 </td>
290 </tr>
291<tr>
292 <td width="15%" align="right" valign="top" class="summary">
293 <span class="summary-type">&nbsp;</span>
294 </td><td class="summary">
295 <a name="alt_param"></a><span class="summary-name">alt_param</span> = <code title="None">None</code>
296 </td>
297 </tr>
298</table>
299<!-- ==================== PROPERTIES ==================== -->
300<a name="section-Properties"></a>
301<table class="summary" border="1" cellpadding="3"
302 cellspacing="0" width="100%" bgcolor="white">
303<tr bgcolor="#70b0f0" class="table-header">
304 <td colspan="2" class="table-header">
305 <table border="0" cellpadding="0" cellspacing="0" width="100%">
306 <tr valign="top">
307 <td align="left"><span class="table-header">Properties</span></td>
308 <td align="right" valign="top"
309 ><span class="options">[<a href="#section-Properties"
310 class="privatelink" onclick="toggle_private();"
311 >hide private</a>]</span></td>
312 </tr>
313 </table>
314 </td>
315</tr>
316 <tr>
317 <td colspan="2" class="summary">
318 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
319 <code>__class__</code>
320 </p>
321 </td>
322 </tr>
323</table>
324<!-- ==================== METHOD DETAILS ==================== -->
325<a name="section-MethodDetails"></a>
326<table class="details" border="1" cellpadding="3"
327 cellspacing="0" width="100%" bgcolor="white">
328<tr bgcolor="#70b0f0" class="table-header">
329 <td colspan="2" class="table-header">
330 <table border="0" cellpadding="0" cellspacing="0" width="100%">
331 <tr valign="top">
332 <td align="left"><span class="table-header">Method Details</span></td>
333 <td align="right" valign="top"
334 ><span class="options">[<a href="#section-MethodDetails"
335 class="privatelink" onclick="toggle_private();"
336 >hide private</a>]</span></td>
337 </tr>
338 </table>
339 </td>
340</tr>
341</table>
342<a name="request"></a>
343<div>
344<table class="details" border="1" cellpadding="3"
345 cellspacing="0" width="100%" bgcolor="white">
346<tr><td>
347 <table width="100%" cellpadding="0" cellspacing="0" border="0">
348 <tr valign="top"><td>
349 <h3 class="epydoc"><span class="sig"><span class="sig-name">request</span>(<span class="sig-arg">self</span>,
350 <span class="sig-arg">headers</span>,
351 <span class="sig-arg">path_params</span>,
352 <span class="sig-arg">query_params</span>,
353 <span class="sig-arg">body_value</span>)</span>
354 </h3>
355 </td><td align="right" valign="top"
356 ><span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel.request">source&nbsp;code</a></span>&nbsp;
357 </td>
358 </tr></table>
359
360 <pre class="literalblock">
361Updates outgoing requests with a serialized body.
362
363Args:
364 headers: dict, request headers
365 path_params: dict, parameters that appear in the request path
366 query_params: dict, parameters that appear in the query
367 body_value: object, the request body as a Python object, which must be
368 serializable by simplejson.
369Returns:
370 A tuple of (headers, path_params, query, body)
371
372 headers: dict, request headers
373 path_params: dict, parameters that appear in the request path
374 query: string, query part of the request URI
375 body: string, the body serialized as JSON
376
377</pre>
378 <dl class="fields">
379 <dt>Overrides:
380 <a href="apiclient.model.Model-class.html#request">Model.request</a>
381 </dt>
382 </dl>
383</td></tr></table>
384</div>
385<a name="_build_query"></a>
386<div class="private">
387<table class="details" border="1" cellpadding="3"
388 cellspacing="0" width="100%" bgcolor="white">
389<tr><td>
390 <table width="100%" cellpadding="0" cellspacing="0" border="0">
391 <tr valign="top"><td>
392 <h3 class="epydoc"><span class="sig"><span class="sig-name">_build_query</span>(<span class="sig-arg">self</span>,
393 <span class="sig-arg">params</span>)</span>
394 </h3>
395 </td><td align="right" valign="top"
396 ><span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel._build_query">source&nbsp;code</a></span>&nbsp;
397 </td>
398 </tr></table>
399
400 <pre class="literalblock">
401Builds a query string.
402
403Args:
404 params: dict, the query parameters
405
406Returns:
407 The query parameters properly encoded into an HTTP URI query string.
408
409</pre>
410 <dl class="fields">
411 </dl>
412</td></tr></table>
413</div>
414<a name="response"></a>
415<div>
416<table class="details" border="1" cellpadding="3"
417 cellspacing="0" width="100%" bgcolor="white">
418<tr><td>
419 <table width="100%" cellpadding="0" cellspacing="0" border="0">
420 <tr valign="top"><td>
421 <h3 class="epydoc"><span class="sig"><span class="sig-name">response</span>(<span class="sig-arg">self</span>,
422 <span class="sig-arg">resp</span>,
423 <span class="sig-arg">content</span>)</span>
424 </h3>
425 </td><td align="right" valign="top"
426 ><span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel.response">source&nbsp;code</a></span>&nbsp;
427 </td>
428 </tr></table>
429
430 <pre class="literalblock">
431Convert the response wire format into a Python object.
432
433Args:
434 resp: httplib2.Response, the HTTP response headers and status
435 content: string, the body of the HTTP response
436
437Returns:
438 The body de-serialized as a Python object.
439
440Raises:
441 apiclient.errors.HttpError if a non 2xx response is received.
442
443</pre>
444 <dl class="fields">
445 <dt>Overrides:
446 <a href="apiclient.model.Model-class.html#response">Model.response</a>
447 </dt>
448 </dl>
449</td></tr></table>
450</div>
451<a name="serialize"></a>
452<div>
453<table class="details" border="1" cellpadding="3"
454 cellspacing="0" width="100%" bgcolor="white">
455<tr><td>
456 <table width="100%" cellpadding="0" cellspacing="0" border="0">
457 <tr valign="top"><td>
458 <h3 class="epydoc"><span class="sig"><span class="sig-name">serialize</span>(<span class="sig-arg">self</span>,
459 <span class="sig-arg">body_value</span>)</span>
460 </h3>
461 </td><td align="right" valign="top"
462 ><span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel.serialize">source&nbsp;code</a></span>&nbsp;
463 </td>
464 </tr></table>
465
466 <pre class="literalblock">
467Perform the actual Python object serialization.
468
469Args:
470 body_value: object, the request body as a Python object.
471
472Returns:
473 string, the body in serialized form.
474
475</pre>
476 <dl class="fields">
477 </dl>
478</td></tr></table>
479</div>
480<a name="deserialize"></a>
481<div>
482<table class="details" border="1" cellpadding="3"
483 cellspacing="0" width="100%" bgcolor="white">
484<tr><td>
485 <table width="100%" cellpadding="0" cellspacing="0" border="0">
486 <tr valign="top"><td>
487 <h3 class="epydoc"><span class="sig"><span class="sig-name">deserialize</span>(<span class="sig-arg">self</span>,
488 <span class="sig-arg">content</span>)</span>
489 </h3>
490 </td><td align="right" valign="top"
491 ><span class="codelink"><a href="apiclient.model-pysrc.html#BaseModel.deserialize">source&nbsp;code</a></span>&nbsp;
492 </td>
493 </tr></table>
494
495 <pre class="literalblock">
496Perform the actual deserialization from response string to Python
497object.
498
499Args:
500 content: string, the body of the HTTP response
501
502Returns:
503 The body de-serialized as a Python object.
504
505</pre>
506 <dl class="fields">
507 </dl>
508</td></tr></table>
509</div>
510<br />
511<!-- ==================== NAVIGATION BAR ==================== -->
512<table class="navbar" border="0" width="100%" cellpadding="0"
513 bgcolor="#a0c0ff" cellspacing="0">
514 <tr valign="middle">
515
516 <!-- Tree link -->
517 <th>&nbsp;&nbsp;&nbsp;<a
518 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
519
520 <!-- Index link -->
521 <th>&nbsp;&nbsp;&nbsp;<a
522 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
523
524 <!-- Help link -->
525 <th>&nbsp;&nbsp;&nbsp;<a
526 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
527
528 <th class="navbar" width="100%"></th>
529 </tr>
530</table>
531<table border="0" cellpadding="0" cellspacing="0" width="100%%">
532 <tr>
533 <td align="left" class="footer">
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame^]534 Generated by Epydoc 3.0.1 on Mon Nov 5 08:53:54 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]535 </td>
536 <td align="right" class="footer">
537 <a target="mainFrame" href="http://epydoc.sourceforge.net"
538 >http://epydoc.sourceforge.net</a>
539 </td>
540 </tr>
541</table>
542
543<script type="text/javascript">
544 <!--
545 // Private objects are initially displayed (because if
546 // javascript is turned off then we want them to be
547 // visible); but by default, we want to hide them. So hide
548 // them unless we have a cookie that says to show them.
549 checkCookie();
550 // -->
551</script>
552</body>
553</html>