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