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