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