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