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