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