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