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