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