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.Model</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;Model
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.Model-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 Model</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html#Model">source&nbsp;code</a></span></p>
60<pre class="base-tree">
61object --+
62         |
63        <strong class="uidshort">Model</strong>
64</pre>
65
66<dl><dt>Known Subclasses:</dt>
67<dd>
68      <ul class="subclass-list">
69<li><a href="googleapiclient.model.BaseModel-class.html">BaseModel</a></li>  </ul>
70</dd></dl>
71
72<hr />
73<p>Model base class.</p>
74  <p>All Model classes should implement this interface. The Model
75  serializes and de-serializes between a wire format such as JSON and a
76  Python object representation.</p>
77
78<!-- ==================== INSTANCE METHODS ==================== -->
79<a name="section-InstanceMethods"></a>
80<table class="summary" border="1" cellpadding="3"
81       cellspacing="0" width="100%" bgcolor="white">
82<tr bgcolor="#70b0f0" class="table-header">
83  <td colspan="2" class="table-header">
84    <table border="0" cellpadding="0" cellspacing="0" width="100%">
85      <tr valign="top">
86        <td align="left"><span class="table-header">Instance Methods</span></td>
87        <td align="right" valign="top"
88         ><span class="options">[<a href="#section-InstanceMethods"
89         class="privatelink" onclick="toggle_private();"
90         >hide private</a>]</span></td>
91      </tr>
92    </table>
93  </td>
94</tr>
95<tr>
96    <td width="15%" align="right" valign="top" class="summary">
97      <span class="summary-type">&nbsp;</span>
98    </td><td class="summary">
99      <table width="100%" cellpadding="0" cellspacing="0" border="0">
100        <tr>
101          <td><span class="summary-sig"><a href="googleapiclient.model.Model-class.html#request" class="summary-sig-name">request</a>(<span class="summary-sig-arg">self</span>,
102        <span class="summary-sig-arg">headers</span>,
103        <span class="summary-sig-arg">path_params</span>,
104        <span class="summary-sig-arg">query_params</span>,
105        <span class="summary-sig-arg">body_value</span>)</span><br />
106      Updates outgoing requests with a serialized body.</td>
107          <td align="right" valign="top">
108            <span class="codelink"><a href="googleapiclient.model-pysrc.html#Model.request">source&nbsp;code</a></span>
109
110          </td>
111        </tr>
112      </table>
113
114    </td>
115  </tr>
116<tr>
117    <td width="15%" align="right" valign="top" class="summary">
118      <span class="summary-type">&nbsp;</span>
119    </td><td class="summary">
120      <table width="100%" cellpadding="0" cellspacing="0" border="0">
121        <tr>
122          <td><span class="summary-sig"><a href="googleapiclient.model.Model-class.html#response" class="summary-sig-name">response</a>(<span class="summary-sig-arg">self</span>,
123        <span class="summary-sig-arg">resp</span>,
124        <span class="summary-sig-arg">content</span>)</span><br />
125      Convert the response wire format into a Python object.</td>
126          <td align="right" valign="top">
127            <span class="codelink"><a href="googleapiclient.model-pysrc.html#Model.response">source&nbsp;code</a></span>
128
129          </td>
130        </tr>
131      </table>
132
133    </td>
134  </tr>
135  <tr>
136    <td colspan="2" class="summary">
137    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
138      <code>__delattr__</code>,
139      <code>__format__</code>,
140      <code>__getattribute__</code>,
141      <code>__hash__</code>,
142      <code>__init__</code>,
143      <code>__new__</code>,
144      <code>__reduce__</code>,
145      <code>__reduce_ex__</code>,
146      <code>__repr__</code>,
147      <code>__setattr__</code>,
148      <code>__sizeof__</code>,
149      <code>__str__</code>,
150      <code>__subclasshook__</code>
151      </p>
152    </td>
153  </tr>
154</table>
155<!-- ==================== PROPERTIES ==================== -->
156<a name="section-Properties"></a>
157<table class="summary" border="1" cellpadding="3"
158       cellspacing="0" width="100%" bgcolor="white">
159<tr bgcolor="#70b0f0" class="table-header">
160  <td colspan="2" class="table-header">
161    <table border="0" cellpadding="0" cellspacing="0" width="100%">
162      <tr valign="top">
163        <td align="left"><span class="table-header">Properties</span></td>
164        <td align="right" valign="top"
165         ><span class="options">[<a href="#section-Properties"
166         class="privatelink" onclick="toggle_private();"
167         >hide private</a>]</span></td>
168      </tr>
169    </table>
170  </td>
171</tr>
172  <tr>
173    <td colspan="2" class="summary">
174    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
175      <code>__class__</code>
176      </p>
177    </td>
178  </tr>
179</table>
180<!-- ==================== METHOD DETAILS ==================== -->
181<a name="section-MethodDetails"></a>
182<table class="details" border="1" cellpadding="3"
183       cellspacing="0" width="100%" bgcolor="white">
184<tr bgcolor="#70b0f0" class="table-header">
185  <td colspan="2" class="table-header">
186    <table border="0" cellpadding="0" cellspacing="0" width="100%">
187      <tr valign="top">
188        <td align="left"><span class="table-header">Method Details</span></td>
189        <td align="right" valign="top"
190         ><span class="options">[<a href="#section-MethodDetails"
191         class="privatelink" onclick="toggle_private();"
192         >hide private</a>]</span></td>
193      </tr>
194    </table>
195  </td>
196</tr>
197</table>
198<a name="request"></a>
199<div>
200<table class="details" border="1" cellpadding="3"
201       cellspacing="0" width="100%" bgcolor="white">
202<tr><td>
203  <table width="100%" cellpadding="0" cellspacing="0" border="0">
204  <tr valign="top"><td>
205  <h3 class="epydoc"><span class="sig"><span class="sig-name">request</span>(<span class="sig-arg">self</span>,
206        <span class="sig-arg">headers</span>,
207        <span class="sig-arg">path_params</span>,
208        <span class="sig-arg">query_params</span>,
209        <span class="sig-arg">body_value</span>)</span>
210  </h3>
211  </td><td align="right" valign="top"
212    ><span class="codelink"><a href="googleapiclient.model-pysrc.html#Model.request">source&nbsp;code</a></span>&nbsp;
213    </td>
214  </tr></table>
215
216  <pre class="literalblock">
217Updates outgoing requests with a serialized body.
218
219Args:
220  headers: dict, request headers
221  path_params: dict, parameters that appear in the request path
222  query_params: dict, parameters that appear in the query
223  body_value: object, the request body as a Python object, which must be
224              serializable.
225Returns:
226  A tuple of (headers, path_params, query, body)
227
228  headers: dict, request headers
229  path_params: dict, parameters that appear in the request path
230  query: string, query part of the request URI
231  body: string, the body serialized in the desired wire format.
232
233</pre>
234  <dl class="fields">
235  </dl>
236</td></tr></table>
237</div>
238<a name="response"></a>
239<div>
240<table class="details" border="1" cellpadding="3"
241       cellspacing="0" width="100%" bgcolor="white">
242<tr><td>
243  <table width="100%" cellpadding="0" cellspacing="0" border="0">
244  <tr valign="top"><td>
245  <h3 class="epydoc"><span class="sig"><span class="sig-name">response</span>(<span class="sig-arg">self</span>,
246        <span class="sig-arg">resp</span>,
247        <span class="sig-arg">content</span>)</span>
248  </h3>
249  </td><td align="right" valign="top"
250    ><span class="codelink"><a href="googleapiclient.model-pysrc.html#Model.response">source&nbsp;code</a></span>&nbsp;
251    </td>
252  </tr></table>
253
254  <pre class="literalblock">
255Convert the response wire format into a Python object.
256
257Args:
258  resp: httplib2.Response, the HTTP response headers and status
259  content: string, the body of the HTTP response
260
261Returns:
262  The body de-serialized as a Python object.
263
264Raises:
265  googleapiclient.errors.HttpError if a non 2xx response is received.
266
267</pre>
268  <dl class="fields">
269  </dl>
270</td></tr></table>
271</div>
272<br />
273<!-- ==================== NAVIGATION BAR ==================== -->
274<table class="navbar" border="0" width="100%" cellpadding="0"
275       bgcolor="#a0c0ff" cellspacing="0">
276  <tr valign="middle">
277  <!-- Home link -->
278      <th>&nbsp;&nbsp;&nbsp;<a
279        href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
280
281  <!-- Tree link -->
282      <th>&nbsp;&nbsp;&nbsp;<a
283        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
284
285  <!-- Index link -->
286      <th>&nbsp;&nbsp;&nbsp;<a
287        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
288
289  <!-- Help link -->
290      <th>&nbsp;&nbsp;&nbsp;<a
291        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
292
293      <th class="navbar" width="100%"></th>
294  </tr>
295</table>
296<table border="0" cellpadding="0" cellspacing="0" width="100%%">
297  <tr>
298    <td align="left" class="footer">
299    Generated by Epydoc 3.0.1 on Fri Oct  2 20:46:22 2020
300    </td>
301    <td align="right" class="footer">
302      <a target="mainFrame" href="http://epydoc.sourceforge.net"
303        >http://epydoc.sourceforge.net</a>
304    </td>
305  </tr>
306</table>
307
308<script type="text/javascript">
309  <!--
310  // Private objects are initially displayed (because if
311  // javascript is turned off then we want them to be
312  // visible); but by default, we want to hide them.  So hide
313  // them unless we have a cookie that says to show them.
314  checkCookie();
315  // -->
316</script>
317</body>
318</html>
319