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