Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / epy / apiclient.model.Model-class.html
blob: 4513b735501703350570fca7a2b27696406ff404 [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.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
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;Model
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.Model-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 Model</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.model-pysrc.html#Model">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_36" name="uml_class_diagram_for_apiclien_36">
59<area shape="rect" id="node89" href="apiclient.model.Model-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,39,397,57"/>
60<area shape="rect" id="node89" href="apiclient.model.Model-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,57,397,76"/>
61<area shape="rect" id="node1" href="apiclient.model.Model-class.html" title="Model base class." alt="" coords="5,6,408,82"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]62</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]63 <img src="uml_class_diagram_for_apiclien_36.gif" alt='' usemap="#uml_class_diagram_for_apiclien_36" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]64</center>
65</center>
66<hr />
67<pre class="literalblock">
68Model base class.
69
70All Model classes should implement this interface.
71The Model serializes and de-serializes between a wire
72format such as JSON and a Python object representation.
73
74</pre>
75
76<!-- ==================== INSTANCE METHODS ==================== -->
77<a name="section-InstanceMethods"></a>
78<table class="summary" border="1" cellpadding="3"
79 cellspacing="0" width="100%" bgcolor="white">
80<tr bgcolor="#70b0f0" class="table-header">
81 <td colspan="2" class="table-header">
82 <table border="0" cellpadding="0" cellspacing="0" width="100%">
83 <tr valign="top">
84 <td align="left"><span class="table-header">Instance Methods</span></td>
85 <td align="right" valign="top"
86 ><span class="options">[<a href="#section-InstanceMethods"
87 class="privatelink" onclick="toggle_private();"
88 >hide private</a>]</span></td>
89 </tr>
90 </table>
91 </td>
92</tr>
93<tr>
94 <td width="15%" align="right" valign="top" class="summary">
95 <span class="summary-type">&nbsp;</span>
96 </td><td class="summary">
97 <table width="100%" cellpadding="0" cellspacing="0" border="0">
98 <tr>
99 <td><span class="summary-sig"><a href="apiclient.model.Model-class.html#request" class="summary-sig-name">request</a>(<span class="summary-sig-arg">self</span>,
100 <span class="summary-sig-arg">headers</span>,
101 <span class="summary-sig-arg">path_params</span>,
102 <span class="summary-sig-arg">query_params</span>,
103 <span class="summary-sig-arg">body_value</span>)</span><br />
104 Updates outgoing requests with a serialized body.</td>
105 <td align="right" valign="top">
106 <span class="codelink"><a href="apiclient.model-pysrc.html#Model.request">source&nbsp;code</a></span>
107
108 </td>
109 </tr>
110 </table>
111
112 </td>
113 </tr>
114<tr>
115 <td width="15%" align="right" valign="top" class="summary">
116 <span class="summary-type">&nbsp;</span>
117 </td><td class="summary">
118 <table width="100%" cellpadding="0" cellspacing="0" border="0">
119 <tr>
120 <td><span class="summary-sig"><a href="apiclient.model.Model-class.html#response" class="summary-sig-name">response</a>(<span class="summary-sig-arg">self</span>,
121 <span class="summary-sig-arg">resp</span>,
122 <span class="summary-sig-arg">content</span>)</span><br />
123 Convert the response wire format into a Python object.</td>
124 <td align="right" valign="top">
125 <span class="codelink"><a href="apiclient.model-pysrc.html#Model.response">source&nbsp;code</a></span>
126
127 </td>
128 </tr>
129 </table>
130
131 </td>
132 </tr>
133 <tr>
134 <td colspan="2" class="summary">
135 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
136 <code>__delattr__</code>,
137 <code>__format__</code>,
138 <code>__getattribute__</code>,
139 <code>__hash__</code>,
140 <code>__init__</code>,
141 <code>__new__</code>,
142 <code>__reduce__</code>,
143 <code>__reduce_ex__</code>,
144 <code>__repr__</code>,
145 <code>__setattr__</code>,
146 <code>__sizeof__</code>,
147 <code>__str__</code>,
148 <code>__subclasshook__</code>
149 </p>
150 </td>
151 </tr>
152</table>
153<!-- ==================== PROPERTIES ==================== -->
154<a name="section-Properties"></a>
155<table class="summary" border="1" cellpadding="3"
156 cellspacing="0" width="100%" bgcolor="white">
157<tr bgcolor="#70b0f0" class="table-header">
158 <td colspan="2" class="table-header">
159 <table border="0" cellpadding="0" cellspacing="0" width="100%">
160 <tr valign="top">
161 <td align="left"><span class="table-header">Properties</span></td>
162 <td align="right" valign="top"
163 ><span class="options">[<a href="#section-Properties"
164 class="privatelink" onclick="toggle_private();"
165 >hide private</a>]</span></td>
166 </tr>
167 </table>
168 </td>
169</tr>
170 <tr>
171 <td colspan="2" class="summary">
172 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
173 <code>__class__</code>
174 </p>
175 </td>
176 </tr>
177</table>
178<!-- ==================== METHOD DETAILS ==================== -->
179<a name="section-MethodDetails"></a>
180<table class="details" border="1" cellpadding="3"
181 cellspacing="0" width="100%" bgcolor="white">
182<tr bgcolor="#70b0f0" class="table-header">
183 <td colspan="2" class="table-header">
184 <table border="0" cellpadding="0" cellspacing="0" width="100%">
185 <tr valign="top">
186 <td align="left"><span class="table-header">Method Details</span></td>
187 <td align="right" valign="top"
188 ><span class="options">[<a href="#section-MethodDetails"
189 class="privatelink" onclick="toggle_private();"
190 >hide private</a>]</span></td>
191 </tr>
192 </table>
193 </td>
194</tr>
195</table>
196<a name="request"></a>
197<div>
198<table class="details" border="1" cellpadding="3"
199 cellspacing="0" width="100%" bgcolor="white">
200<tr><td>
201 <table width="100%" cellpadding="0" cellspacing="0" border="0">
202 <tr valign="top"><td>
203 <h3 class="epydoc"><span class="sig"><span class="sig-name">request</span>(<span class="sig-arg">self</span>,
204 <span class="sig-arg">headers</span>,
205 <span class="sig-arg">path_params</span>,
206 <span class="sig-arg">query_params</span>,
207 <span class="sig-arg">body_value</span>)</span>
208 </h3>
209 </td><td align="right" valign="top"
210 ><span class="codelink"><a href="apiclient.model-pysrc.html#Model.request">source&nbsp;code</a></span>&nbsp;
211 </td>
212 </tr></table>
213
214 <pre class="literalblock">
215Updates outgoing requests with a serialized body.
216
217Args:
218 headers: dict, request headers
219 path_params: dict, parameters that appear in the request path
220 query_params: dict, parameters that appear in the query
221 body_value: object, the request body as a Python object, which must be
222 serializable.
223Returns:
224 A tuple of (headers, path_params, query, body)
225
226 headers: dict, request headers
227 path_params: dict, parameters that appear in the request path
228 query: string, query part of the request URI
229 body: string, the body serialized in the desired wire format.
230
231</pre>
232 <dl class="fields">
233 </dl>
234</td></tr></table>
235</div>
236<a name="response"></a>
237<div>
238<table class="details" border="1" cellpadding="3"
239 cellspacing="0" width="100%" bgcolor="white">
240<tr><td>
241 <table width="100%" cellpadding="0" cellspacing="0" border="0">
242 <tr valign="top"><td>
243 <h3 class="epydoc"><span class="sig"><span class="sig-name">response</span>(<span class="sig-arg">self</span>,
244 <span class="sig-arg">resp</span>,
245 <span class="sig-arg">content</span>)</span>
246 </h3>
247 </td><td align="right" valign="top"
248 ><span class="codelink"><a href="apiclient.model-pysrc.html#Model.response">source&nbsp;code</a></span>&nbsp;
249 </td>
250 </tr></table>
251
252 <pre class="literalblock">
253Convert the response wire format into a Python object.
254
255Args:
256 resp: httplib2.Response, the HTTP response headers and status
257 content: string, the body of the HTTP response
258
259Returns:
260 The body de-serialized as a Python object.
261
262Raises:
263 apiclient.errors.HttpError if a non 2xx response is received.
264
265</pre>
266 <dl class="fields">
267 </dl>
268</td></tr></table>
269</div>
270<br />
271<!-- ==================== NAVIGATION BAR ==================== -->
272<table class="navbar" border="0" width="100%" cellpadding="0"
273 bgcolor="#a0c0ff" cellspacing="0">
274 <tr valign="middle">
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">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]294 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:44 2013
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -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>