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