Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / apiclient.model.ProtocolBufferModel-class.html
blob: e4809244d5275a2e6d1652536c096587728b20de [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>
58<center> <map id="uml_class_diagram_for_apiclien_25" name="uml_class_diagram_for_apiclien_25">
59<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#accept" title="apiclient.model.ProtocolBufferModel.accept" alt="" coords="120,183,291,201"/>
60<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#content_type" title="apiclient.model.ProtocolBufferModel.content_type" alt="" coords="120,201,291,220"/>
61<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#alt_param" title="apiclient.model.ProtocolBufferModel.alt_param" alt="" coords="120,220,291,239"/>
62<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#no_content_response" title="apiclient.model.ProtocolBufferModel.no_content_response" alt="" coords="120,239,291,257"/>
63<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#__init__" title="Constructs a ProtocolBufferModel." alt="" coords="120,260,291,279"/>
64<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="120,279,291,297"/>
65<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="120,297,291,316"/>
66<area shape="rect" href="apiclient.model.ProtocolBufferModel-class.html" title="Model class for protocol buffers." alt="" coords="119,165,292,317"/>
67<area shape="rect" href="apiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,97,393,116"/>
68<area shape="rect" href="apiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,116,393,135"/>
69<area shape="rect" href="apiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="16,72,395,136"/>
70<area shape="rect" href="apiclient.model.Model-class.html" title="Model base class." alt="" coords="187,11,224,43"/>
71</map>
72 <img src="uml_class_diagram_for_apiclien_25.gif" alt='' usemap="#uml_class_diagram_for_apiclien_25" ismap="ismap" class="graph-without-title" />
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>
156 <tr>
157 <td colspan="2" class="summary">
158 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b>:
159 <code><a href="apiclient.model.BaseModel-class.html#request">request</a></code>,
160 <code><a href="apiclient.model.BaseModel-class.html#response">response</a></code>
161 </p>
162 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b> (private):
163 <code><a href="apiclient.model.BaseModel-class.html#_build_query" onclick="show_private();">_build_query</a></code>,
164 <code><a href="apiclient.model.BaseModel-class.html#_log_request" onclick="show_private();">_log_request</a></code>,
165 <code><a href="apiclient.model.BaseModel-class.html#_log_response" onclick="show_private();">_log_response</a></code>
166 </p></div>
167 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
168 <code>__delattr__</code>,
169 <code>__format__</code>,
170 <code>__getattribute__</code>,
171 <code>__hash__</code>,
172 <code>__new__</code>,
173 <code>__reduce__</code>,
174 <code>__reduce_ex__</code>,
175 <code>__repr__</code>,
176 <code>__setattr__</code>,
177 <code>__sizeof__</code>,
178 <code>__str__</code>,
179 <code>__subclasshook__</code>
180 </p>
181 </td>
182 </tr>
183</table>
184<!-- ==================== CLASS VARIABLES ==================== -->
185<a name="section-ClassVariables"></a>
186<table class="summary" border="1" cellpadding="3"
187 cellspacing="0" width="100%" bgcolor="white">
188<tr bgcolor="#70b0f0" class="table-header">
189 <td colspan="2" class="table-header">
190 <table border="0" cellpadding="0" cellspacing="0" width="100%">
191 <tr valign="top">
192 <td align="left"><span class="table-header">Class Variables</span></td>
193 <td align="right" valign="top"
194 ><span class="options">[<a href="#section-ClassVariables"
195 class="privatelink" onclick="toggle_private();"
196 >hide private</a>]</span></td>
197 </tr>
198 </table>
199 </td>
200</tr>
201<tr>
202 <td width="15%" align="right" valign="top" class="summary">
203 <span class="summary-type">&nbsp;</span>
204 </td><td class="summary">
205 <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>
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">
212 <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>
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">
219 <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>
220 </td>
221 </tr>
222</table>
223<!-- ==================== PROPERTIES ==================== -->
224<a name="section-Properties"></a>
225<table class="summary" border="1" cellpadding="3"
226 cellspacing="0" width="100%" bgcolor="white">
227<tr bgcolor="#70b0f0" class="table-header">
228 <td colspan="2" class="table-header">
229 <table border="0" cellpadding="0" cellspacing="0" width="100%">
230 <tr valign="top">
231 <td align="left"><span class="table-header">Properties</span></td>
232 <td align="right" valign="top"
233 ><span class="options">[<a href="#section-Properties"
234 class="privatelink" onclick="toggle_private();"
235 >hide private</a>]</span></td>
236 </tr>
237 </table>
238 </td>
239</tr>
240<tr>
241 <td width="15%" align="right" valign="top" class="summary">
242 <span class="summary-type">&nbsp;</span>
243 </td><td class="summary">
244 <a href="apiclient.model.ProtocolBufferModel-class.html#no_content_response" class="summary-name">no_content_response</a>
245 </td>
246 </tr>
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>
374<br />
375<!-- ==================== PROPERTY DETAILS ==================== -->
376<a name="section-PropertyDetails"></a>
377<table class="details" border="1" cellpadding="3"
378 cellspacing="0" width="100%" bgcolor="white">
379<tr bgcolor="#70b0f0" class="table-header">
380 <td colspan="2" class="table-header">
381 <table border="0" cellpadding="0" cellspacing="0" width="100%">
382 <tr valign="top">
383 <td align="left"><span class="table-header">Property Details</span></td>
384 <td align="right" valign="top"
385 ><span class="options">[<a href="#section-PropertyDetails"
386 class="privatelink" onclick="toggle_private();"
387 >hide private</a>]</span></td>
388 </tr>
389 </table>
390 </td>
391</tr>
392</table>
393<a name="no_content_response"></a>
394<div>
395<table class="details" border="1" cellpadding="3"
396 cellspacing="0" width="100%" bgcolor="white">
397<tr><td>
398 <h3 class="epydoc">no_content_response</h3>
399
400 <dl class="fields">
401 <dt>Get Method:</dt>
402 <dd class="value"><span class="summary-sig"><i>unreachable</i>.no_content_response(<span class="summary-sig-arg">self</span>)</span>
403 </dd>
404 </dl>
405</td></tr></table>
406</div>
407<br />
408<!-- ==================== NAVIGATION BAR ==================== -->
409<table class="navbar" border="0" width="100%" cellpadding="0"
410 bgcolor="#a0c0ff" cellspacing="0">
411 <tr valign="middle">
412
413 <!-- Tree link -->
414 <th>&nbsp;&nbsp;&nbsp;<a
415 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
416
417 <!-- Index link -->
418 <th>&nbsp;&nbsp;&nbsp;<a
419 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
420
421 <!-- Help link -->
422 <th>&nbsp;&nbsp;&nbsp;<a
423 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
424
425 <th class="navbar" width="100%"></th>
426 </tr>
427</table>
428<table border="0" cellpadding="0" cellspacing="0" width="100%%">
429 <tr>
430 <td align="left" class="footer">
431 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012
432 </td>
433 <td align="right" class="footer">
434 <a target="mainFrame" href="http://epydoc.sourceforge.net"
435 >http://epydoc.sourceforge.net</a>
436 </td>
437 </tr>
438</table>
439
440<script type="text/javascript">
441 <!--
442 // Private objects are initially displayed (because if
443 // javascript is turned off then we want them to be
444 // visible); but by default, we want to hide them. So hide
445 // them unless we have a cookie that says to show them.
446 checkCookie();
447 // -->
448</script>
449</body>
450</html>