Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / apiclient.http.MediaUpload-class.html
blob: d798223379e7e69695a21eee61449eb3a496003b [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.http.MediaUpload</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.http-module.html">Module&nbsp;http</a> ::
39 Class&nbsp;MediaUpload
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.http.MediaUpload-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 MediaUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_apiclien_19" name="uml_class_diagram_for_apiclien_19">
59<area shape="rect" href="apiclient.http.MediaUpload-class.html#getbytes" title="apiclient.http.MediaUpload.getbytes" alt="" coords="84,36,236,55"/>
60<area shape="rect" href="apiclient.http.MediaUpload-class.html#size" title="apiclient.http.MediaUpload.size" alt="" coords="84,55,236,73"/>
61<area shape="rect" href="apiclient.http.MediaUpload-class.html#chunksize" title="apiclient.http.MediaUpload.chunksize" alt="" coords="84,73,236,92"/>
62<area shape="rect" href="apiclient.http.MediaUpload-class.html#mimetype" title="apiclient.http.MediaUpload.mimetype" alt="" coords="84,92,236,111"/>
63<area shape="rect" href="apiclient.http.MediaUpload-class.html#resumable" title="apiclient.http.MediaUpload.resumable" alt="" coords="84,111,236,129"/>
64<area shape="rect" href="apiclient.http.MediaUpload-class.html#to_json" title="Create a JSON representation of an instance of MediaUpload." alt="" coords="84,129,236,148"/>
65<area shape="rect" href="apiclient.http.MediaUpload-class.html#new_from_json" title="Utility class method to instantiate a MediaUpload subclass from a JSON representation produced by to_json()." alt="" coords="84,148,236,167"/>
66<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="83,11,237,168"/>
67<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="A MediaUpload for a file." alt="" coords="16,197,125,224"/>
68<area shape="rect" href="apiclient.http.MediaInMemoryUpload-class.html" title="MediaUpload for a chunk of bytes." alt="" coords="176,197,323,224"/>
69</map>
70 <img src="uml_class_diagram_for_apiclien_19.gif" alt='' usemap="#uml_class_diagram_for_apiclien_19" ismap="ismap" class="graph-without-title" />
71</center>
72</center>
73<hr />
74<pre class="literalblock">
75Describes a media object to upload.
76
77Base class that defines the interface of MediaUpload subclasses.
78
79</pre>
80
81<!-- ==================== INSTANCE METHODS ==================== -->
82<a name="section-InstanceMethods"></a>
83<table class="summary" border="1" cellpadding="3"
84 cellspacing="0" width="100%" bgcolor="white">
85<tr bgcolor="#70b0f0" class="table-header">
86 <td colspan="2" class="table-header">
87 <table border="0" cellpadding="0" cellspacing="0" width="100%">
88 <tr valign="top">
89 <td align="left"><span class="table-header">Instance Methods</span></td>
90 <td align="right" valign="top"
91 ><span class="options">[<a href="#section-InstanceMethods"
92 class="privatelink" onclick="toggle_private();"
93 >hide private</a>]</span></td>
94 </tr>
95 </table>
96 </td>
97</tr>
98<tr>
99 <td width="15%" align="right" valign="top" class="summary">
100 <span class="summary-type">&nbsp;</span>
101 </td><td class="summary">
102 <table width="100%" cellpadding="0" cellspacing="0" border="0">
103 <tr>
104 <td><span class="summary-sig"><a name="getbytes"></a><span class="summary-sig-name">getbytes</span>(<span class="summary-sig-arg">self</span>,
105 <span class="summary-sig-arg">begin</span>,
106 <span class="summary-sig-arg">end</span>)</span></td>
107 <td align="right" valign="top">
108 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.getbytes">source&nbsp;code</a></span>
109
110 </td>
111 </tr>
112 </table>
113
114 </td>
115 </tr>
116<tr>
117 <td width="15%" align="right" valign="top" class="summary">
118 <span class="summary-type">&nbsp;</span>
119 </td><td class="summary">
120 <table width="100%" cellpadding="0" cellspacing="0" border="0">
121 <tr>
122 <td><span class="summary-sig"><a name="size"></a><span class="summary-sig-name">size</span>(<span class="summary-sig-arg">self</span>)</span></td>
123 <td align="right" valign="top">
124 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.size">source&nbsp;code</a></span>
125
126 </td>
127 </tr>
128 </table>
129
130 </td>
131 </tr>
132<tr>
133 <td width="15%" align="right" valign="top" class="summary">
134 <span class="summary-type">&nbsp;</span>
135 </td><td class="summary">
136 <table width="100%" cellpadding="0" cellspacing="0" border="0">
137 <tr>
138 <td><span class="summary-sig"><a name="chunksize"></a><span class="summary-sig-name">chunksize</span>(<span class="summary-sig-arg">self</span>)</span></td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.chunksize">source&nbsp;code</a></span>
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
148<tr>
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <td><span class="summary-sig"><a name="mimetype"></a><span class="summary-sig-name">mimetype</span>(<span class="summary-sig-arg">self</span>)</span></td>
155 <td align="right" valign="top">
156 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.mimetype">source&nbsp;code</a></span>
157
158 </td>
159 </tr>
160 </table>
161
162 </td>
163 </tr>
164<tr>
165 <td width="15%" align="right" valign="top" class="summary">
166 <span class="summary-type">&nbsp;</span>
167 </td><td class="summary">
168 <table width="100%" cellpadding="0" cellspacing="0" border="0">
169 <tr>
170 <td><span class="summary-sig"><a name="resumable"></a><span class="summary-sig-name">resumable</span>(<span class="summary-sig-arg">self</span>)</span></td>
171 <td align="right" valign="top">
172 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.resumable">source&nbsp;code</a></span>
173
174 </td>
175 </tr>
176 </table>
177
178 </td>
179 </tr>
180<tr class="private">
181 <td width="15%" align="right" valign="top" class="summary">
182 <span class="summary-type">&nbsp;</span>
183 </td><td class="summary">
184 <table width="100%" cellpadding="0" cellspacing="0" border="0">
185 <tr>
186 <td><span class="summary-sig"><a href="apiclient.http.MediaUpload-class.html#_to_json" class="summary-sig-name" onclick="show_private();">_to_json</a>(<span class="summary-sig-arg">self</span>,
187 <span class="summary-sig-arg">strip</span>=<span class="summary-sig-default">None</span>)</span><br />
188 Utility function for creating a JSON representation of a MediaUpload.</td>
189 <td align="right" valign="top">
190 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload._to_json">source&nbsp;code</a></span>
191
192 </td>
193 </tr>
194 </table>
195
196 </td>
197 </tr>
198<tr>
199 <td width="15%" align="right" valign="top" class="summary">
200 <span class="summary-type">&nbsp;</span>
201 </td><td class="summary">
202 <table width="100%" cellpadding="0" cellspacing="0" border="0">
203 <tr>
204 <td><span class="summary-sig"><a href="apiclient.http.MediaUpload-class.html#to_json" class="summary-sig-name">to_json</a>(<span class="summary-sig-arg">self</span>)</span><br />
205 Create a JSON representation of an instance of MediaUpload.</td>
206 <td align="right" valign="top">
207 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.to_json">source&nbsp;code</a></span>
208
209 </td>
210 </tr>
211 </table>
212
213 </td>
214 </tr>
215 <tr>
216 <td colspan="2" class="summary">
217 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
218 <code>__delattr__</code>,
219 <code>__format__</code>,
220 <code>__getattribute__</code>,
221 <code>__hash__</code>,
222 <code>__init__</code>,
223 <code>__new__</code>,
224 <code>__reduce__</code>,
225 <code>__reduce_ex__</code>,
226 <code>__repr__</code>,
227 <code>__setattr__</code>,
228 <code>__sizeof__</code>,
229 <code>__str__</code>,
230 <code>__subclasshook__</code>
231 </p>
232 </td>
233 </tr>
234</table>
235<!-- ==================== CLASS METHODS ==================== -->
236<a name="section-ClassMethods"></a>
237<table class="summary" border="1" cellpadding="3"
238 cellspacing="0" width="100%" bgcolor="white">
239<tr bgcolor="#70b0f0" class="table-header">
240 <td colspan="2" class="table-header">
241 <table border="0" cellpadding="0" cellspacing="0" width="100%">
242 <tr valign="top">
243 <td align="left"><span class="table-header">Class Methods</span></td>
244 <td align="right" valign="top"
245 ><span class="options">[<a href="#section-ClassMethods"
246 class="privatelink" onclick="toggle_private();"
247 >hide private</a>]</span></td>
248 </tr>
249 </table>
250 </td>
251</tr>
252<tr>
253 <td width="15%" align="right" valign="top" class="summary">
254 <span class="summary-type">&nbsp;</span>
255 </td><td class="summary">
256 <table width="100%" cellpadding="0" cellspacing="0" border="0">
257 <tr>
258 <td><span class="summary-sig"><a href="apiclient.http.MediaUpload-class.html#new_from_json" class="summary-sig-name">new_from_json</a>(<span class="summary-sig-arg">cls</span>,
259 <span class="summary-sig-arg">s</span>)</span><br />
260 Utility class method to instantiate a MediaUpload subclass from a JSON
261representation produced by to_json().</td>
262 <td align="right" valign="top">
263 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.new_from_json">source&nbsp;code</a></span>
264
265 </td>
266 </tr>
267 </table>
268
269 </td>
270 </tr>
271</table>
272<!-- ==================== PROPERTIES ==================== -->
273<a name="section-Properties"></a>
274<table class="summary" border="1" cellpadding="3"
275 cellspacing="0" width="100%" bgcolor="white">
276<tr bgcolor="#70b0f0" class="table-header">
277 <td colspan="2" class="table-header">
278 <table border="0" cellpadding="0" cellspacing="0" width="100%">
279 <tr valign="top">
280 <td align="left"><span class="table-header">Properties</span></td>
281 <td align="right" valign="top"
282 ><span class="options">[<a href="#section-Properties"
283 class="privatelink" onclick="toggle_private();"
284 >hide private</a>]</span></td>
285 </tr>
286 </table>
287 </td>
288</tr>
289 <tr>
290 <td colspan="2" class="summary">
291 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
292 <code>__class__</code>
293 </p>
294 </td>
295 </tr>
296</table>
297<!-- ==================== METHOD DETAILS ==================== -->
298<a name="section-MethodDetails"></a>
299<table class="details" border="1" cellpadding="3"
300 cellspacing="0" width="100%" bgcolor="white">
301<tr bgcolor="#70b0f0" class="table-header">
302 <td colspan="2" class="table-header">
303 <table border="0" cellpadding="0" cellspacing="0" width="100%">
304 <tr valign="top">
305 <td align="left"><span class="table-header">Method Details</span></td>
306 <td align="right" valign="top"
307 ><span class="options">[<a href="#section-MethodDetails"
308 class="privatelink" onclick="toggle_private();"
309 >hide private</a>]</span></td>
310 </tr>
311 </table>
312 </td>
313</tr>
314</table>
315<a name="_to_json"></a>
316<div class="private">
317<table class="details" border="1" cellpadding="3"
318 cellspacing="0" width="100%" bgcolor="white">
319<tr><td>
320 <table width="100%" cellpadding="0" cellspacing="0" border="0">
321 <tr valign="top"><td>
322 <h3 class="epydoc"><span class="sig"><span class="sig-name">_to_json</span>(<span class="sig-arg">self</span>,
323 <span class="sig-arg">strip</span>=<span class="sig-default">None</span>)</span>
324 </h3>
325 </td><td align="right" valign="top"
326 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload._to_json">source&nbsp;code</a></span>&nbsp;
327 </td>
328 </tr></table>
329
330 <pre class="literalblock">
331Utility function for creating a JSON representation of a MediaUpload.
332
333Args:
334 strip: array, An array of names of members to not include in the JSON.
335
336Returns:
337 string, a JSON representation of this instance, suitable to pass to
338 from_json().
339
340</pre>
341 <dl class="fields">
342 </dl>
343</td></tr></table>
344</div>
345<a name="to_json"></a>
346<div>
347<table class="details" border="1" cellpadding="3"
348 cellspacing="0" width="100%" bgcolor="white">
349<tr><td>
350 <table width="100%" cellpadding="0" cellspacing="0" border="0">
351 <tr valign="top"><td>
352 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
353 </h3>
354 </td><td align="right" valign="top"
355 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.to_json">source&nbsp;code</a></span>&nbsp;
356 </td>
357 </tr></table>
358
359 <pre class="literalblock">
360Create a JSON representation of an instance of MediaUpload.
361
362Returns:
363 string, a JSON representation of this instance, suitable to pass to
364 from_json().
365
366</pre>
367 <dl class="fields">
368 </dl>
369</td></tr></table>
370</div>
371<a name="new_from_json"></a>
372<div>
373<table class="details" border="1" cellpadding="3"
374 cellspacing="0" width="100%" bgcolor="white">
375<tr><td>
376 <table width="100%" cellpadding="0" cellspacing="0" border="0">
377 <tr valign="top"><td>
378 <h3 class="epydoc"><span class="sig"><span class="sig-name">new_from_json</span>(<span class="sig-arg">cls</span>,
379 <span class="sig-arg">s</span>)</span>
380 <br /><em class="fname">Class Method</em>
381 </h3>
382 </td><td align="right" valign="top"
383 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUpload.new_from_json">source&nbsp;code</a></span>&nbsp;
384 </td>
385 </tr></table>
386
387 <pre class="literalblock">
388Utility class method to instantiate a MediaUpload subclass from a JSON
389representation produced by to_json().
390
391Args:
392 s: string, JSON from to_json().
393
394Returns:
395 An instance of the subclass of MediaUpload that was serialized with
396 to_json().
397
398</pre>
399 <dl class="fields">
400 </dl>
401</td></tr></table>
402</div>
403<br />
404<!-- ==================== NAVIGATION BAR ==================== -->
405<table class="navbar" border="0" width="100%" cellpadding="0"
406 bgcolor="#a0c0ff" cellspacing="0">
407 <tr valign="middle">
408
409 <!-- Tree link -->
410 <th>&nbsp;&nbsp;&nbsp;<a
411 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
412
413 <!-- Index link -->
414 <th>&nbsp;&nbsp;&nbsp;<a
415 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
416
417 <!-- Help link -->
418 <th>&nbsp;&nbsp;&nbsp;<a
419 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
420
421 <th class="navbar" width="100%"></th>
422 </tr>
423</table>
424<table border="0" cellpadding="0" cellspacing="0" width="100%%">
425 <tr>
426 <td align="left" class="footer">
427 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:07 2012
428 </td>
429 <td align="right" class="footer">
430 <a target="mainFrame" href="http://epydoc.sourceforge.net"
431 >http://epydoc.sourceforge.net</a>
432 </td>
433 </tr>
434</table>
435
436<script type="text/javascript">
437 <!--
438 // Private objects are initially displayed (because if
439 // javascript is turned off then we want them to be
440 // visible); but by default, we want to hide them. So hide
441 // them unless we have a cookie that says to show them.
442 checkCookie();
443 // -->
444</script>
445</body>
446</html>