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