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