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