Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / epy / apiclient.model.MediaModel-class.html
blob: 06cfdde61cd35fb99789a5a13a352f526d83e879 [file] [log] [blame]
Joe Gregorioebd0b842012-06-15 14:14:17 -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.MediaModel</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;MediaModel
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.MediaModel-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 MediaModel</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel">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_35" name="uml_class_diagram_for_apiclien_35">
59<area shape="rect" id="node85" href="apiclient.model.MediaModel-class.html#accept" title="apiclient.model.MediaModel.accept" alt="" coords="128,287,288,305"/>
60<area shape="rect" id="node85" href="apiclient.model.MediaModel-class.html#content_type" title="apiclient.model.MediaModel.content_type" alt="" coords="128,305,288,324"/>
61<area shape="rect" id="node85" href="apiclient.model.MediaModel-class.html#alt_param" title="apiclient.model.MediaModel.alt_param" alt="" coords="128,324,288,343"/>
62<area shape="rect" id="node85" href="apiclient.model.MediaModel-class.html#deserialize" title="Perform the actual deserialization from response string to Python object." alt="" coords="128,345,288,364"/>
63<area shape="rect" id="node85" href="apiclient.model.MediaModel-class.html#no_content_response" title="apiclient.model.MediaModel.no_content_response" alt="" coords="128,364,288,383"/>
64<area shape="rect" id="node1" href="apiclient.model.MediaModel-class.html" title="Model class for requests that return Media." alt="" coords="116,262,300,389"/>
65<area shape="rect" id="node86" href="apiclient.model.JsonModel-class.html#__init__" title="Construct a JsonModel." alt="" coords="104,199,312,217"/>
66<area shape="rect" id="node86" href="apiclient.model.JsonModel-class.html#serialize" title="Perform the actual Python object serialization." alt="" coords="104,217,312,236"/>
67<area shape="rect" id="node2" href="apiclient.model.JsonModel-class.html" title="Model class for JSON." alt="" coords="92,166,324,242"/>
68<area shape="rect" id="node87" href="apiclient.model.BaseModel-class.html#request" title="Updates outgoing requests with a serialized body." alt="" coords="17,103,397,121"/>
69<area shape="rect" id="node87" href="apiclient.model.BaseModel-class.html#response" title="Convert the response wire format into a Python object." alt="" coords="17,121,397,140"/>
70<area shape="rect" id="node3" href="apiclient.model.BaseModel-class.html" title="Base model class." alt="" coords="5,70,408,146"/>
71<area shape="rect" id="node4" href="apiclient.model.Model-class.html" title="Model base class." alt="" coords="177,6,239,50"/>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]72</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]73 <img src="uml_class_diagram_for_apiclien_35.gif" alt='' usemap="#uml_class_diagram_for_apiclien_35" ismap="ismap" class="graph-without-title" />
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]74</center>
75</center>
76<hr />
77<pre class="literalblock">
78Model class for requests that return Media.
79
80Serializes and de-serializes between JSON and the Python
81object representation of HTTP request, and returns the raw bytes
82of the response body.
83
84</pre>
85
86<!-- ==================== INSTANCE METHODS ==================== -->
87<a name="section-InstanceMethods"></a>
88<table class="summary" border="1" cellpadding="3"
89 cellspacing="0" width="100%" bgcolor="white">
90<tr bgcolor="#70b0f0" class="table-header">
91 <td colspan="2" class="table-header">
92 <table border="0" cellpadding="0" cellspacing="0" width="100%">
93 <tr valign="top">
94 <td align="left"><span class="table-header">Instance Methods</span></td>
95 <td align="right" valign="top"
96 ><span class="options">[<a href="#section-InstanceMethods"
97 class="privatelink" onclick="toggle_private();"
98 >hide private</a>]</span></td>
99 </tr>
100 </table>
101 </td>
102</tr>
103<tr>
104 <td width="15%" align="right" valign="top" class="summary">
105 <span class="summary-type">&nbsp;</span>
106 </td><td class="summary">
107 <table width="100%" cellpadding="0" cellspacing="0" border="0">
108 <tr>
109 <td><span class="summary-sig"><a href="apiclient.model.MediaModel-class.html#deserialize" class="summary-sig-name">deserialize</a>(<span class="summary-sig-arg">self</span>,
110 <span class="summary-sig-arg">content</span>)</span><br />
111 Perform the actual deserialization from response string to Python
112object.</td>
113 <td align="right" valign="top">
114 <span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.deserialize">source&nbsp;code</a></span>
115
116 </td>
117 </tr>
118 </table>
119
120 </td>
121 </tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]122<tr>
123 <td width="15%" align="right" valign="top" class="summary">
124 <span class="summary-type">&nbsp;</span>
125 </td><td class="summary">
126 <table width="100%" cellpadding="0" cellspacing="0" border="0">
127 <tr>
128 <td><span class="summary-sig"><a href="apiclient.model.MediaModel-class.html#no_content_response" class="summary-sig-name">no_content_response</a>(<span class="summary-sig-arg">self</span>)</span></td>
129 <td align="right" valign="top">
130 <span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.no_content_response">source&nbsp;code</a></span>
131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]138 <tr>
139 <td colspan="2" class="summary">
140 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.JsonModel-class.html">JsonModel</a></code></b>:
141 <code><a href="apiclient.model.JsonModel-class.html#__init__">__init__</a></code>,
142 <code><a href="apiclient.model.JsonModel-class.html#serialize">serialize</a></code>
143 </p>
144 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b>:
145 <code><a href="apiclient.model.BaseModel-class.html#request">request</a></code>,
146 <code><a href="apiclient.model.BaseModel-class.html#response">response</a></code>
147 </p>
148 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.model.BaseModel-class.html">BaseModel</a></code></b> (private):
149 <code><a href="apiclient.model.BaseModel-class.html#_build_query" onclick="show_private();">_build_query</a></code>,
150 <code><a href="apiclient.model.BaseModel-class.html#_log_request" onclick="show_private();">_log_request</a></code>,
151 <code><a href="apiclient.model.BaseModel-class.html#_log_response" onclick="show_private();">_log_response</a></code>
152 </p></div>
153 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
154 <code>__delattr__</code>,
155 <code>__format__</code>,
156 <code>__getattribute__</code>,
157 <code>__hash__</code>,
158 <code>__new__</code>,
159 <code>__reduce__</code>,
160 <code>__reduce_ex__</code>,
161 <code>__repr__</code>,
162 <code>__setattr__</code>,
163 <code>__sizeof__</code>,
164 <code>__str__</code>,
165 <code>__subclasshook__</code>
166 </p>
167 </td>
168 </tr>
169</table>
170<!-- ==================== CLASS VARIABLES ==================== -->
171<a name="section-ClassVariables"></a>
172<table class="summary" border="1" cellpadding="3"
173 cellspacing="0" width="100%" bgcolor="white">
174<tr bgcolor="#70b0f0" class="table-header">
175 <td colspan="2" class="table-header">
176 <table border="0" cellpadding="0" cellspacing="0" width="100%">
177 <tr valign="top">
178 <td align="left"><span class="table-header">Class Variables</span></td>
179 <td align="right" valign="top"
180 ><span class="options">[<a href="#section-ClassVariables"
181 class="privatelink" onclick="toggle_private();"
182 >hide private</a>]</span></td>
183 </tr>
184 </table>
185 </td>
186</tr>
187<tr>
188 <td width="15%" align="right" valign="top" class="summary">
189 <span class="summary-type">&nbsp;</span>
190 </td><td class="summary">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]191 <a name="accept"></a><span class="summary-name">accept</span> = <code title="'*/*'">'*/*'</code>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]192 </td>
193 </tr>
194<tr>
195 <td width="15%" align="right" valign="top" class="summary">
196 <span class="summary-type">&nbsp;</span>
197 </td><td class="summary">
198 <a name="content_type"></a><span class="summary-name">content_type</span> = <code title="'application/json'">'application/json'</code>
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">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]205 <a name="alt_param"></a><span class="summary-name">alt_param</span> = <code title="'media'">'media'</code>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]206 </td>
207 </tr>
208</table>
209<!-- ==================== PROPERTIES ==================== -->
210<a name="section-Properties"></a>
211<table class="summary" border="1" cellpadding="3"
212 cellspacing="0" width="100%" bgcolor="white">
213<tr bgcolor="#70b0f0" class="table-header">
214 <td colspan="2" class="table-header">
215 <table border="0" cellpadding="0" cellspacing="0" width="100%">
216 <tr valign="top">
217 <td align="left"><span class="table-header">Properties</span></td>
218 <td align="right" valign="top"
219 ><span class="options">[<a href="#section-Properties"
220 class="privatelink" onclick="toggle_private();"
221 >hide private</a>]</span></td>
222 </tr>
223 </table>
224 </td>
225</tr>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]226 <tr>
227 <td colspan="2" class="summary">
228 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
229 <code>__class__</code>
230 </p>
231 </td>
232 </tr>
233</table>
234<!-- ==================== METHOD DETAILS ==================== -->
235<a name="section-MethodDetails"></a>
236<table class="details" border="1" cellpadding="3"
237 cellspacing="0" width="100%" bgcolor="white">
238<tr bgcolor="#70b0f0" class="table-header">
239 <td colspan="2" class="table-header">
240 <table border="0" cellpadding="0" cellspacing="0" width="100%">
241 <tr valign="top">
242 <td align="left"><span class="table-header">Method Details</span></td>
243 <td align="right" valign="top"
244 ><span class="options">[<a href="#section-MethodDetails"
245 class="privatelink" onclick="toggle_private();"
246 >hide private</a>]</span></td>
247 </tr>
248 </table>
249 </td>
250</tr>
251</table>
252<a name="deserialize"></a>
253<div>
254<table class="details" border="1" cellpadding="3"
255 cellspacing="0" width="100%" bgcolor="white">
256<tr><td>
257 <table width="100%" cellpadding="0" cellspacing="0" border="0">
258 <tr valign="top"><td>
259 <h3 class="epydoc"><span class="sig"><span class="sig-name">deserialize</span>(<span class="sig-arg">self</span>,
260 <span class="sig-arg">content</span>)</span>
261 </h3>
262 </td><td align="right" valign="top"
263 ><span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.deserialize">source&nbsp;code</a></span>&nbsp;
264 </td>
265 </tr></table>
266
267 <pre class="literalblock">
268Perform the actual deserialization from response string to Python
269object.
270
271Args:
272 content: string, the body of the HTTP response
273
274Returns:
275 The body de-serialized as a Python object.
276
277</pre>
278 <dl class="fields">
279 <dt>Overrides:
280 <a href="apiclient.model.BaseModel-class.html#deserialize">BaseModel.deserialize</a>
281 <dd><em class="note">(inherited documentation)</em></dd>
282 </dt>
283 </dl>
284</td></tr></table>
285</div>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]286<a name="no_content_response"></a>
287<div>
288<table class="details" border="1" cellpadding="3"
289 cellspacing="0" width="100%" bgcolor="white">
290<tr><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]291 <table width="100%" cellpadding="0" cellspacing="0" border="0">
292 <tr valign="top"><td>
293 <h3 class="epydoc"><span class="sig"><span class="sig-name">no_content_response</span>(<span class="sig-arg">self</span>)</span>
294 </h3>
295 </td><td align="right" valign="top"
296 ><span class="codelink"><a href="apiclient.model-pysrc.html#MediaModel.no_content_response">source&nbsp;code</a></span>&nbsp;
297 </td>
298 </tr></table>
299
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]300
301 <dl class="fields">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]302 <dt>Decorators:</dt>
303 <dd><ul class="nomargin-top">
304 <li><code>@property</code></li>
305 </ul></dd>
306 <dt>Overrides:
307 <a href="apiclient.model.BaseModel-class.html#no_content_response">no_content_response</a>
308 </dt>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]309 </dl>
310</td></tr></table>
311</div>
312<br />
313<!-- ==================== NAVIGATION BAR ==================== -->
314<table class="navbar" border="0" width="100%" cellpadding="0"
315 bgcolor="#a0c0ff" cellspacing="0">
316 <tr valign="middle">
317
318 <!-- Tree link -->
319 <th>&nbsp;&nbsp;&nbsp;<a
320 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
321
322 <!-- Index link -->
323 <th>&nbsp;&nbsp;&nbsp;<a
324 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
325
326 <!-- Help link -->
327 <th>&nbsp;&nbsp;&nbsp;<a
328 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
329
330 <th class="navbar" width="100%"></th>
331 </tr>
332</table>
333<table border="0" cellpadding="0" cellspacing="0" width="100%%">
334 <tr>
335 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]336 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:44 2013
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]337 </td>
338 <td align="right" class="footer">
339 <a target="mainFrame" href="http://epydoc.sourceforge.net"
340 >http://epydoc.sourceforge.net</a>
341 </td>
342 </tr>
343</table>
344
345<script type="text/javascript">
346 <!--
347 // Private objects are initially displayed (because if
348 // javascript is turned off then we want them to be
349 // visible); but by default, we want to hide them. So hide
350 // them unless we have a cookie that says to show them.
351 checkCookie();
352 // -->
353</script>
354</body>
355</html>