Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 66212035140c8f3abfb6ed14a40db27dbef4d220 / . / docs / epy / apiclient.model.RawModel-class.html
blob: 4a70aa26698c6afb0a65db5bb8ea7cfcb3355220 [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.RawModel</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;RawModel
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.RawModel-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 RawModel</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.model-pysrc.html#RawModel">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]58<center> <map id="uml_class_diagram_for_apiclien_27" name="uml_class_diagram_for_apiclien_27">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]59<area shape="rect" href="apiclient.model.RawModel-class.html#accept" title="apiclient.model.RawModel.accept" alt="" coords="132,276,279,295"/>
60<area shape="rect" href="apiclient.model.RawModel-class.html#content_type" title="apiclient.model.RawModel.content_type" alt="" coords="132,295,279,313"/>
61<area shape="rect" href="apiclient.model.RawModel-class.html#alt_param" title="apiclient.model.RawModel.alt_param" alt="" coords="132,313,279,332"/>
62<area shape="rect" href="apiclient.model.RawModel-class.html#no_content_response" title="apiclient.model.RawModel.no_content_response" alt="" coords="132,332,279,351"/>
63<area shape="rect" href="apiclient.model.RawModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="132,353,279,372"/>
64<area shape="rect" href="apiclient.model.RawModel-class.html" title="Model class for requests that don&#39;t return JSON." alt="" coords="131,259,280,373"/>
65<area shape="rect" href="apiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="103,191,308,209"/>
66<area shape="rect" href="apiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="103,209,308,228"/>
67<area shape="rect" href="apiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="101,165,309,229"/>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]68<area shape="rect" href="apiclient.model.Model-class.html" title="Model base class." alt="" coords="187,11,224,43"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]69<area shape="rect" href="apiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,97,393,116"/>
70<area shape="rect" href="apiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,116,393,135"/>
71<area shape="rect" href="apiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="16,72,395,136"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]72</map>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]73 <img src="uml_class_diagram_for_apiclien_27.gif" alt='' usemap="#uml_class_diagram_for_apiclien_27" ismap="ismap" class="graph-without-title" />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]74</center>
75</center>
76<hr />
77<pre class="literalblock">
78Model class for requests that don't return JSON.
79
80Serializes and de-serializes between JSON and the Python
81object representation of HTTP request, and returns the raw bytes
82of the response body.
83
84</pre>
85
86<!-- ==================== INSTANCE METHODS ==================== -->
87<a name="section-InstanceMethods"></a>
88<table class="summary" border="1" cellpadding="3"
89 cellspacing="0" width="100%" bgcolor="white">
90<tr bgcolor="#70b0f0" class="table-header">
91 <td colspan="2" class="table-header">
92 <table border="0" cellpadding="0" cellspacing="0" width="100%">
93 <tr valign="top">
94 <td align="left"><span class="table-header">Instance Methods</span></td>
95 <td align="right" valign="top"
96 ><span class="options">[<a href="#section-InstanceMethods"
97 class="privatelink" onclick="toggle_private();"
98 >hide private</a>]</span></td>
99 </tr>
100 </table>
101 </td>
102</tr>
103<tr>
104 <td width="15%" align="right" valign="top" class="summary">
105 <span class="summary-type">&nbsp;</span>
106 </td><td class="summary">
107 <table width="100%" cellpadding="0" cellspacing="0" border="0">
108 <tr>
109 <td><span class="summary-sig"><a href="apiclient.model.RawModel-class.html#deserialize" class="summary-sig-name">deserialize</a>(<span class="summary-sig-arg">self</span>,
110 <span class="summary-sig-arg">content</span>)</span><br />
111 Perform the actual deserialization from response string to Python
112object.</td>
113 <td align="right" valign="top">
114 <span class="codelink"><a href="apiclient.model-pysrc.html#RawModel.deserialize">source&nbsp;code</a></span>
115
116 </td>
117 </tr>
118 </table>
119
120 </td>
121 </tr>
122 <tr>
123 <td colspan="2" class="summary">
124 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.JsonModel-class.html">JsonModel</a></code></b>:
125 <code><a href="apiclient.model.JsonModel-class.html#__init__">__init__</a></code>,
126 <code><a href="apiclient.model.JsonModel-class.html#serialize">serialize</a></code>
127 </p>
128 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b>:
129 <code><a href="apiclient.model.BaseModel-class.html#request">request</a></code>,
130 <code><a href="apiclient.model.BaseModel-class.html#response">response</a></code>
131 </p>
132 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b> (private):
133 <code><a href="apiclient.model.BaseModel-class.html#_build_query" onclick="show_private();">_build_query</a></code>,
134 <code><a href="apiclient.model.BaseModel-class.html#_log_request" onclick="show_private();">_log_request</a></code>,
135 <code><a href="apiclient.model.BaseModel-class.html#_log_response" onclick="show_private();">_log_response</a></code>
136 </p></div>
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>__new__</code>,
143 <code>__reduce__</code>,
144 <code>__reduce_ex__</code>,
145 <code>__repr__</code>,
146 <code>__setattr__</code>,
147 <code>__sizeof__</code>,
148 <code>__str__</code>,
149 <code>__subclasshook__</code>
150 </p>
151 </td>
152 </tr>
153</table>
154<!-- ==================== CLASS VARIABLES ==================== -->
155<a name="section-ClassVariables"></a>
156<table class="summary" border="1" cellpadding="3"
157 cellspacing="0" width="100%" bgcolor="white">
158<tr bgcolor="#70b0f0" class="table-header">
159 <td colspan="2" class="table-header">
160 <table border="0" cellpadding="0" cellspacing="0" width="100%">
161 <tr valign="top">
162 <td align="left"><span class="table-header">Class Variables</span></td>
163 <td align="right" valign="top"
164 ><span class="options">[<a href="#section-ClassVariables"
165 class="privatelink" onclick="toggle_private();"
166 >hide private</a>]</span></td>
167 </tr>
168 </table>
169 </td>
170</tr>
171<tr>
172 <td width="15%" align="right" valign="top" class="summary">
173 <span class="summary-type">&nbsp;</span>
174 </td><td class="summary">
175 <a name="accept"></a><span class="summary-name">accept</span> = <code title="'*/*'"><code class="variable-quote">'</code><code class="variable-string">*/*</code><code class="variable-quote">'</code></code>
176 </td>
177 </tr>
178<tr>
179 <td width="15%" align="right" valign="top" class="summary">
180 <span class="summary-type">&nbsp;</span>
181 </td><td class="summary">
182 <a name="content_type"></a><span class="summary-name">content_type</span> = <code title="'application/json'">'application/json'</code>
183 </td>
184 </tr>
185<tr>
186 <td width="15%" align="right" valign="top" class="summary">
187 <span class="summary-type">&nbsp;</span>
188 </td><td class="summary">
189 <a name="alt_param"></a><span class="summary-name">alt_param</span> = <code title="None">None</code>
190 </td>
191 </tr>
192</table>
193<!-- ==================== PROPERTIES ==================== -->
194<a name="section-Properties"></a>
195<table class="summary" border="1" cellpadding="3"
196 cellspacing="0" width="100%" bgcolor="white">
197<tr bgcolor="#70b0f0" class="table-header">
198 <td colspan="2" class="table-header">
199 <table border="0" cellpadding="0" cellspacing="0" width="100%">
200 <tr valign="top">
201 <td align="left"><span class="table-header">Properties</span></td>
202 <td align="right" valign="top"
203 ><span class="options">[<a href="#section-Properties"
204 class="privatelink" onclick="toggle_private();"
205 >hide private</a>]</span></td>
206 </tr>
207 </table>
208 </td>
209</tr>
210<tr>
211 <td width="15%" align="right" valign="top" class="summary">
212 <span class="summary-type">&nbsp;</span>
213 </td><td class="summary">
214 <a href="apiclient.model.RawModel-class.html#no_content_response" class="summary-name">no_content_response</a>
215 </td>
216 </tr>
217 <tr>
218 <td colspan="2" class="summary">
219 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
220 <code>__class__</code>
221 </p>
222 </td>
223 </tr>
224</table>
225<!-- ==================== METHOD DETAILS ==================== -->
226<a name="section-MethodDetails"></a>
227<table class="details" border="1" cellpadding="3"
228 cellspacing="0" width="100%" bgcolor="white">
229<tr bgcolor="#70b0f0" class="table-header">
230 <td colspan="2" class="table-header">
231 <table border="0" cellpadding="0" cellspacing="0" width="100%">
232 <tr valign="top">
233 <td align="left"><span class="table-header">Method Details</span></td>
234 <td align="right" valign="top"
235 ><span class="options">[<a href="#section-MethodDetails"
236 class="privatelink" onclick="toggle_private();"
237 >hide private</a>]</span></td>
238 </tr>
239 </table>
240 </td>
241</tr>
242</table>
243<a name="deserialize"></a>
244<div>
245<table class="details" border="1" cellpadding="3"
246 cellspacing="0" width="100%" bgcolor="white">
247<tr><td>
248 <table width="100%" cellpadding="0" cellspacing="0" border="0">
249 <tr valign="top"><td>
250 <h3 class="epydoc"><span class="sig"><span class="sig-name">deserialize</span>(<span class="sig-arg">self</span>,
251 <span class="sig-arg">content</span>)</span>
252 </h3>
253 </td><td align="right" valign="top"
254 ><span class="codelink"><a href="apiclient.model-pysrc.html#RawModel.deserialize">source&nbsp;code</a></span>&nbsp;
255 </td>
256 </tr></table>
257
258 <pre class="literalblock">
259Perform the actual deserialization from response string to Python
260object.
261
262Args:
263 content: string, the body of the HTTP response
264
265Returns:
266 The body de-serialized as a Python object.
267
268</pre>
269 <dl class="fields">
270 <dt>Overrides:
271 <a href="apiclient.model.BaseModel-class.html#deserialize">BaseModel.deserialize</a>
272 <dd><em class="note">(inherited documentation)</em></dd>
273 </dt>
274 </dl>
275</td></tr></table>
276</div>
277<br />
278<!-- ==================== PROPERTY DETAILS ==================== -->
279<a name="section-PropertyDetails"></a>
280<table class="details" border="1" cellpadding="3"
281 cellspacing="0" width="100%" bgcolor="white">
282<tr bgcolor="#70b0f0" class="table-header">
283 <td colspan="2" class="table-header">
284 <table border="0" cellpadding="0" cellspacing="0" width="100%">
285 <tr valign="top">
286 <td align="left"><span class="table-header">Property Details</span></td>
287 <td align="right" valign="top"
288 ><span class="options">[<a href="#section-PropertyDetails"
289 class="privatelink" onclick="toggle_private();"
290 >hide private</a>]</span></td>
291 </tr>
292 </table>
293 </td>
294</tr>
295</table>
296<a name="no_content_response"></a>
297<div>
298<table class="details" border="1" cellpadding="3"
299 cellspacing="0" width="100%" bgcolor="white">
300<tr><td>
301 <h3 class="epydoc">no_content_response</h3>
302
303 <dl class="fields">
304 <dt>Get Method:</dt>
305 <dd class="value"><span class="summary-sig"><i>unreachable</i>.no_content_response(<span class="summary-sig-arg">self</span>)</span>
306 </dd>
307 </dl>
308</td></tr></table>
309</div>
310<br />
311<!-- ==================== NAVIGATION BAR ==================== -->
312<table class="navbar" border="0" width="100%" cellpadding="0"
313 bgcolor="#a0c0ff" cellspacing="0">
314 <tr valign="middle">
315
316 <!-- Tree link -->
317 <th>&nbsp;&nbsp;&nbsp;<a
318 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
319
320 <!-- Index link -->
321 <th>&nbsp;&nbsp;&nbsp;<a
322 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
323
324 <!-- Help link -->
325 <th>&nbsp;&nbsp;&nbsp;<a
326 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
327
328 <th class="navbar" width="100%"></th>
329 </tr>
330</table>
331<table border="0" cellpadding="0" cellspacing="0" width="100%%">
332 <tr>
333 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]334 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]335 </td>
336 <td align="right" class="footer">
337 <a target="mainFrame" href="http://epydoc.sourceforge.net"
338 >http://epydoc.sourceforge.net</a>
339 </td>
340 </tr>
341</table>
342
343<script type="text/javascript">
344 <!--
345 // Private objects are initially displayed (because if
346 // javascript is turned off then we want them to be
347 // visible); but by default, we want to hide them. So hide
348 // them unless we have a cookie that says to show them.
349 checkCookie();
350 // -->
351</script>
352</body>
353</html>