Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / apiclient.model.JsonModel-class.html
blob: a479e38d19cf1b0023ee83fcf3e8b4b435f23802 [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.JsonModel</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;JsonModel
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.JsonModel-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 JsonModel</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.model-pysrc.html#JsonModel">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_apiclien_23" name="uml_class_diagram_for_apiclien_23">
59<area shape="rect" href="apiclient.model.JsonModel-class.html#accept" title="apiclient.model.JsonModel.accept" alt="" coords="103,183,308,201"/>
60<area shape="rect" href="apiclient.model.JsonModel-class.html#content_type" title="apiclient.model.JsonModel.content_type" alt="" coords="103,201,308,220"/>
61<area shape="rect" href="apiclient.model.JsonModel-class.html#alt_param" title="apiclient.model.JsonModel.alt_param" alt="" coords="103,220,308,239"/>
62<area shape="rect" href="apiclient.model.JsonModel-class.html#no_content_response" title="apiclient.model.JsonModel.no_content_response" alt="" coords="103,239,308,257"/>
63<area shape="rect" href="apiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="103,260,308,279"/>
64<area shape="rect" href="apiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="103,279,308,297"/>
65<area shape="rect" href="apiclient.model.JsonModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="103,297,308,316"/>
66<area shape="rect" href="apiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="101,165,309,317"/>
67<area shape="rect" href="apiclient.model.RawModel-class.html" title="Model class for requests that don&#39;t return JSON." alt="" coords="168,347,243,373"/>
68<area shape="rect" href="apiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,97,393,116"/>
69<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"/>
70<area shape="rect" href="apiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="16,72,395,136"/>
71<area shape="rect" href="apiclient.model.Model-class.html" title="Model base class." alt="" coords="187,11,224,43"/>
72</map>
73 <img src="uml_class_diagram_for_apiclien_23.gif" alt='' usemap="#uml_class_diagram_for_apiclien_23" ismap="ismap" class="graph-without-title" />
74</center>
75</center>
76<hr />
77<pre class="literalblock">
78Model class for JSON.
79
80Serializes and de-serializes between JSON and the Python
81object representation of HTTP request and response bodies.
82
83</pre>
84
85<!-- ==================== INSTANCE METHODS ==================== -->
86<a name="section-InstanceMethods"></a>
87<table class="summary" border="1" cellpadding="3"
88 cellspacing="0" width="100%" bgcolor="white">
89<tr bgcolor="#70b0f0" class="table-header">
90 <td colspan="2" class="table-header">
91 <table border="0" cellpadding="0" cellspacing="0" width="100%">
92 <tr valign="top">
93 <td align="left"><span class="table-header">Instance Methods</span></td>
94 <td align="right" valign="top"
95 ><span class="options">[<a href="#section-InstanceMethods"
96 class="privatelink" onclick="toggle_private();"
97 >hide private</a>]</span></td>
98 </tr>
99 </table>
100 </td>
101</tr>
102<tr>
103 <td width="15%" align="right" valign="top" class="summary">
104 <span class="summary-type">&nbsp;</span>
105 </td><td class="summary">
106 <table width="100%" cellpadding="0" cellspacing="0" border="0">
107 <tr>
108 <td><span class="summary-sig"><a href="apiclient.model.JsonModel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
109 <span class="summary-sig-arg">data_wrapper</span>=<span class="summary-sig-default">False</span>)</span><br />
110 Construct a JsonModel.</td>
111 <td align="right" valign="top">
112 <span class="codelink"><a href="apiclient.model-pysrc.html#JsonModel.__init__">source&nbsp;code</a></span>
113
114 </td>
115 </tr>
116 </table>
117
118 </td>
119 </tr>
120<tr>
121 <td width="15%" align="right" valign="top" class="summary">
122 <span class="summary-type">&nbsp;</span>
123 </td><td class="summary">
124 <table width="100%" cellpadding="0" cellspacing="0" border="0">
125 <tr>
126 <td><span class="summary-sig"><a href="apiclient.model.JsonModel-class.html#serialize" class="summary-sig-name">serialize</a>(<span class="summary-sig-arg">self</span>,
127 <span class="summary-sig-arg">body_value</span>)</span><br />
128 Perform the actual Python object serialization.</td>
129 <td align="right" valign="top">
130 <span class="codelink"><a href="apiclient.model-pysrc.html#JsonModel.serialize">source&nbsp;code</a></span>
131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
138<tr>
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type">&nbsp;</span>
141 </td><td class="summary">
142 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <tr>
144 <td><span class="summary-sig"><a href="apiclient.model.JsonModel-class.html#deserialize" class="summary-sig-name">deserialize</a>(<span class="summary-sig-arg">self</span>,
145 <span class="summary-sig-arg">content</span>)</span><br />
146 Perform the actual deserialization from response string to Python
147object.</td>
148 <td align="right" valign="top">
149 <span class="codelink"><a href="apiclient.model-pysrc.html#JsonModel.deserialize">source&nbsp;code</a></span>
150
151 </td>
152 </tr>
153 </table>
154
155 </td>
156 </tr>
157 <tr>
158 <td colspan="2" class="summary">
159 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b>:
160 <code><a href="apiclient.model.BaseModel-class.html#request">request</a></code>,
161 <code><a href="apiclient.model.BaseModel-class.html#response">response</a></code>
162 </p>
163 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b> (private):
164 <code><a href="apiclient.model.BaseModel-class.html#_build_query" onclick="show_private();">_build_query</a></code>,
165 <code><a href="apiclient.model.BaseModel-class.html#_log_request" onclick="show_private();">_log_request</a></code>,
166 <code><a href="apiclient.model.BaseModel-class.html#_log_response" onclick="show_private();">_log_response</a></code>
167 </p></div>
168 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
169 <code>__delattr__</code>,
170 <code>__format__</code>,
171 <code>__getattribute__</code>,
172 <code>__hash__</code>,
173 <code>__new__</code>,
174 <code>__reduce__</code>,
175 <code>__reduce_ex__</code>,
176 <code>__repr__</code>,
177 <code>__setattr__</code>,
178 <code>__sizeof__</code>,
179 <code>__str__</code>,
180 <code>__subclasshook__</code>
181 </p>
182 </td>
183 </tr>
184</table>
185<!-- ==================== CLASS VARIABLES ==================== -->
186<a name="section-ClassVariables"></a>
187<table class="summary" border="1" cellpadding="3"
188 cellspacing="0" width="100%" bgcolor="white">
189<tr bgcolor="#70b0f0" class="table-header">
190 <td colspan="2" class="table-header">
191 <table border="0" cellpadding="0" cellspacing="0" width="100%">
192 <tr valign="top">
193 <td align="left"><span class="table-header">Class Variables</span></td>
194 <td align="right" valign="top"
195 ><span class="options">[<a href="#section-ClassVariables"
196 class="privatelink" onclick="toggle_private();"
197 >hide private</a>]</span></td>
198 </tr>
199 </table>
200 </td>
201</tr>
202<tr>
203 <td width="15%" align="right" valign="top" class="summary">
204 <span class="summary-type">&nbsp;</span>
205 </td><td class="summary">
206 <a name="accept"></a><span class="summary-name">accept</span> = <code title="'application/json'"><code class="variable-quote">'</code><code class="variable-string">application/json</code><code class="variable-quote">'</code></code>
207 </td>
208 </tr>
209<tr>
210 <td width="15%" align="right" valign="top" class="summary">
211 <span class="summary-type">&nbsp;</span>
212 </td><td class="summary">
213 <a name="content_type"></a><span class="summary-name">content_type</span> = <code title="'application/json'"><code class="variable-quote">'</code><code class="variable-string">application/json</code><code class="variable-quote">'</code></code>
214 </td>
215 </tr>
216<tr>
217 <td width="15%" align="right" valign="top" class="summary">
218 <span class="summary-type">&nbsp;</span>
219 </td><td class="summary">
220 <a name="alt_param"></a><span class="summary-name">alt_param</span> = <code title="'json'"><code class="variable-quote">'</code><code class="variable-string">json</code><code class="variable-quote">'</code></code>
221 </td>
222 </tr>
223</table>
224<!-- ==================== PROPERTIES ==================== -->
225<a name="section-Properties"></a>
226<table class="summary" border="1" cellpadding="3"
227 cellspacing="0" width="100%" bgcolor="white">
228<tr bgcolor="#70b0f0" class="table-header">
229 <td colspan="2" class="table-header">
230 <table border="0" cellpadding="0" cellspacing="0" width="100%">
231 <tr valign="top">
232 <td align="left"><span class="table-header">Properties</span></td>
233 <td align="right" valign="top"
234 ><span class="options">[<a href="#section-Properties"
235 class="privatelink" onclick="toggle_private();"
236 >hide private</a>]</span></td>
237 </tr>
238 </table>
239 </td>
240</tr>
241<tr>
242 <td width="15%" align="right" valign="top" class="summary">
243 <span class="summary-type">&nbsp;</span>
244 </td><td class="summary">
245 <a href="apiclient.model.JsonModel-class.html#no_content_response" class="summary-name">no_content_response</a>
246 </td>
247 </tr>
248 <tr>
249 <td colspan="2" class="summary">
250 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
251 <code>__class__</code>
252 </p>
253 </td>
254 </tr>
255</table>
256<!-- ==================== METHOD DETAILS ==================== -->
257<a name="section-MethodDetails"></a>
258<table class="details" border="1" cellpadding="3"
259 cellspacing="0" width="100%" bgcolor="white">
260<tr bgcolor="#70b0f0" class="table-header">
261 <td colspan="2" class="table-header">
262 <table border="0" cellpadding="0" cellspacing="0" width="100%">
263 <tr valign="top">
264 <td align="left"><span class="table-header">Method Details</span></td>
265 <td align="right" valign="top"
266 ><span class="options">[<a href="#section-MethodDetails"
267 class="privatelink" onclick="toggle_private();"
268 >hide private</a>]</span></td>
269 </tr>
270 </table>
271 </td>
272</tr>
273</table>
274<a name="__init__"></a>
275<div>
276<table class="details" border="1" cellpadding="3"
277 cellspacing="0" width="100%" bgcolor="white">
278<tr><td>
279 <table width="100%" cellpadding="0" cellspacing="0" border="0">
280 <tr valign="top"><td>
281 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
282 <span class="sig-arg">data_wrapper</span>=<span class="sig-default">False</span>)</span>
283 <br /><em class="fname">(Constructor)</em>
284 </h3>
285 </td><td align="right" valign="top"
286 ><span class="codelink"><a href="apiclient.model-pysrc.html#JsonModel.__init__">source&nbsp;code</a></span>&nbsp;
287 </td>
288 </tr></table>
289
290 <pre class="literalblock">
291Construct a JsonModel.
292
293Args:
294 data_wrapper: boolean, wrap requests and responses in a data wrapper
295
296</pre>
297 <dl class="fields">
298 <dt>Overrides:
299 object.__init__
300 </dt>
301 </dl>
302</td></tr></table>
303</div>
304<a name="serialize"></a>
305<div>
306<table class="details" border="1" cellpadding="3"
307 cellspacing="0" width="100%" bgcolor="white">
308<tr><td>
309 <table width="100%" cellpadding="0" cellspacing="0" border="0">
310 <tr valign="top"><td>
311 <h3 class="epydoc"><span class="sig"><span class="sig-name">serialize</span>(<span class="sig-arg">self</span>,
312 <span class="sig-arg">body_value</span>)</span>
313 </h3>
314 </td><td align="right" valign="top"
315 ><span class="codelink"><a href="apiclient.model-pysrc.html#JsonModel.serialize">source&nbsp;code</a></span>&nbsp;
316 </td>
317 </tr></table>
318
319 <pre class="literalblock">
320Perform the actual Python object serialization.
321
322Args:
323 body_value: object, the request body as a Python object.
324
325Returns:
326 string, the body in serialized form.
327
328</pre>
329 <dl class="fields">
330 <dt>Overrides:
331 <a href="apiclient.model.BaseModel-class.html#serialize">BaseModel.serialize</a>
332 <dd><em class="note">(inherited documentation)</em></dd>
333 </dt>
334 </dl>
335</td></tr></table>
336</div>
337<a name="deserialize"></a>
338<div>
339<table class="details" border="1" cellpadding="3"
340 cellspacing="0" width="100%" bgcolor="white">
341<tr><td>
342 <table width="100%" cellpadding="0" cellspacing="0" border="0">
343 <tr valign="top"><td>
344 <h3 class="epydoc"><span class="sig"><span class="sig-name">deserialize</span>(<span class="sig-arg">self</span>,
345 <span class="sig-arg">content</span>)</span>
346 </h3>
347 </td><td align="right" valign="top"
348 ><span class="codelink"><a href="apiclient.model-pysrc.html#JsonModel.deserialize">source&nbsp;code</a></span>&nbsp;
349 </td>
350 </tr></table>
351
352 <pre class="literalblock">
353Perform the actual deserialization from response string to Python
354object.
355
356Args:
357 content: string, the body of the HTTP response
358
359Returns:
360 The body de-serialized as a Python object.
361
362</pre>
363 <dl class="fields">
364 <dt>Overrides:
365 <a href="apiclient.model.BaseModel-class.html#deserialize">BaseModel.deserialize</a>
366 <dd><em class="note">(inherited documentation)</em></dd>
367 </dt>
368 </dl>
369</td></tr></table>
370</div>
371<br />
372<!-- ==================== PROPERTY DETAILS ==================== -->
373<a name="section-PropertyDetails"></a>
374<table class="details" border="1" cellpadding="3"
375 cellspacing="0" width="100%" bgcolor="white">
376<tr bgcolor="#70b0f0" class="table-header">
377 <td colspan="2" class="table-header">
378 <table border="0" cellpadding="0" cellspacing="0" width="100%">
379 <tr valign="top">
380 <td align="left"><span class="table-header">Property Details</span></td>
381 <td align="right" valign="top"
382 ><span class="options">[<a href="#section-PropertyDetails"
383 class="privatelink" onclick="toggle_private();"
384 >hide private</a>]</span></td>
385 </tr>
386 </table>
387 </td>
388</tr>
389</table>
390<a name="no_content_response"></a>
391<div>
392<table class="details" border="1" cellpadding="3"
393 cellspacing="0" width="100%" bgcolor="white">
394<tr><td>
395 <h3 class="epydoc">no_content_response</h3>
396
397 <dl class="fields">
398 <dt>Get Method:</dt>
399 <dd class="value"><span class="summary-sig"><i>unreachable</i>.no_content_response(<span class="summary-sig-arg">self</span>)</span>
400 </dd>
401 </dl>
402</td></tr></table>
403</div>
404<br />
405<!-- ==================== NAVIGATION BAR ==================== -->
406<table class="navbar" border="0" width="100%" cellpadding="0"
407 bgcolor="#a0c0ff" cellspacing="0">
408 <tr valign="middle">
409
410 <!-- Tree link -->
411 <th>&nbsp;&nbsp;&nbsp;<a
412 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
413
414 <!-- Index link -->
415 <th>&nbsp;&nbsp;&nbsp;<a
416 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
417
418 <!-- Help link -->
419 <th>&nbsp;&nbsp;&nbsp;<a
420 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
421
422 <th class="navbar" width="100%"></th>
423 </tr>
424</table>
425<table border="0" cellpadding="0" cellspacing="0" width="100%%">
426 <tr>
427 <td align="left" class="footer">
428 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012
429 </td>
430 <td align="right" class="footer">
431 <a target="mainFrame" href="http://epydoc.sourceforge.net"
432 >http://epydoc.sourceforge.net</a>
433 </td>
434 </tr>
435</table>
436
437<script type="text/javascript">
438 <!--
439 // Private objects are initially displayed (because if
440 // javascript is turned off then we want them to be
441 // visible); but by default, we want to hide them. So hide
442 // them unless we have a cookie that says to show them.
443 checkCookie();
444 // -->
445</script>
446</body>
447</html>