Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d50cd6883f37e19a26fabe3af6a75d407146520 / . / docs / epy / apiclient.http.MediaIoBaseUpload-class.html
blob: 251672f702aa69f541130faa3c0c1367e4d4beee [file] [log] [blame]
Joe Gregorio66212032012-06-14 09:10:14 -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.MediaIoBaseUpload</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;MediaIoBaseUpload
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.MediaIoBaseUpload-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 MediaIoBaseUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload">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_28" name="uml_class_diagram_for_apiclien_28">
59<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#__init__" title="Constructor." alt="" coords="17,116,520,135"/>
60<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="17,135,520,153"/>
61<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="17,153,520,172"/>
62<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#size" title="Size of upload." alt="" coords="17,172,520,191"/>
63<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="17,191,520,209"/>
64<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="17,209,520,228"/>
65<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="17,228,520,247"/>
66<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="17,247,520,265"/>
67<area shape="rect" id="node74" href="apiclient.http.MediaIoBaseUpload-class.html#to_json" title="This upload type is not serializable." alt="" coords="17,265,520,284"/>
68<area shape="rect" id="node1" href="apiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="5,83,531,290"/>
69<area shape="rect" id="node75" 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="201,39,337,57"/>
70<area shape="rect" id="node2" href="apiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="189,6,349,63"/>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]71</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]72 <img src="uml_class_diagram_for_apiclien_28.gif" alt='' usemap="#uml_class_diagram_for_apiclien_28" ismap="ismap" class="graph-without-title" />
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]73</center>
74</center>
75<hr />
76<pre class="literalblock">
77A MediaUpload for a io.Base objects.
78
79Note that the Python file object is compatible with io.Base and can be used
80with this class also.
81
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]82 fh = io.BytesIO('...Some data to upload...')
83 media = MediaIoBaseUpload(fh, mimetype='image/png',
84 chunksize=1024*1024, resumable=True)
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]85 farm.animals().insert(
86 id='cow',
87 name='cow.png',
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]88 media_body=media).execute()
89
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]90Depending on the platform you are working on, you may pass -1 as the
91chunksize, which indicates that the entire file should be uploaded in a single
92request. If the underlying platform supports streams, such as Python 2.6 or
93later, then this can be very efficient as it avoids multiple connections, and
94also avoids loading the entire file into memory before sending it. Note that
95Google App Engine has a 5MB limit on request size, so you should never set
96your chunksize larger than 5MB, or to -1.
97
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]98</pre>
99
100<!-- ==================== INSTANCE METHODS ==================== -->
101<a name="section-InstanceMethods"></a>
102<table class="summary" border="1" cellpadding="3"
103 cellspacing="0" width="100%" bgcolor="white">
104<tr bgcolor="#70b0f0" class="table-header">
105 <td colspan="2" class="table-header">
106 <table border="0" cellpadding="0" cellspacing="0" width="100%">
107 <tr valign="top">
108 <td align="left"><span class="table-header">Instance Methods</span></td>
109 <td align="right" valign="top"
110 ><span class="options">[<a href="#section-InstanceMethods"
111 class="privatelink" onclick="toggle_private();"
112 >hide private</a>]</span></td>
113 </tr>
114 </table>
115 </td>
116</tr>
117<tr>
118 <td width="15%" align="right" valign="top" class="summary">
119 <span class="summary-type">&nbsp;</span>
120 </td><td class="summary">
121 <table width="100%" cellpadding="0" cellspacing="0" border="0">
122 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]123 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
124 <span class="summary-sig-arg">fd</span>,
125 <span class="summary-sig-arg">mimetype</span>,
126 <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">DEFAULT_CHUNK_SIZE</span>,
127 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]128 Constructor.</td>
129 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]130 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.__init__">source&nbsp;code</a></span>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]131
132 </td>
133 </tr>
134 </table>
135
136 </td>
137 </tr>
138<tr>
139 <td width="15%" align="right" valign="top" class="summary">
140 <span class="summary-type">&nbsp;</span>
141 </td><td class="summary">
142 <table width="100%" cellpadding="0" cellspacing="0" border="0">
143 <tr>
144 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#chunksize" class="summary-sig-name">chunksize</a>(<span class="summary-sig-arg">self</span>)</span><br />
145 Chunk size for resumable uploads.</td>
146 <td align="right" valign="top">
147 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.chunksize">source&nbsp;code</a></span>
148
149 </td>
150 </tr>
151 </table>
152
153 </td>
154 </tr>
155<tr>
156 <td width="15%" align="right" valign="top" class="summary">
157 <span class="summary-type">&nbsp;</span>
158 </td><td class="summary">
159 <table width="100%" cellpadding="0" cellspacing="0" border="0">
160 <tr>
161 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#mimetype" class="summary-sig-name">mimetype</a>(<span class="summary-sig-arg">self</span>)</span><br />
162 Mime type of the body.</td>
163 <td align="right" valign="top">
164 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.mimetype">source&nbsp;code</a></span>
165
166 </td>
167 </tr>
168 </table>
169
170 </td>
171 </tr>
172<tr>
173 <td width="15%" align="right" valign="top" class="summary">
174 <span class="summary-type">&nbsp;</span>
175 </td><td class="summary">
176 <table width="100%" cellpadding="0" cellspacing="0" border="0">
177 <tr>
178 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#size" class="summary-sig-name">size</a>(<span class="summary-sig-arg">self</span>)</span><br />
179 Size of upload.</td>
180 <td align="right" valign="top">
181 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.size">source&nbsp;code</a></span>
182
183 </td>
184 </tr>
185 </table>
186
187 </td>
188 </tr>
189<tr>
190 <td width="15%" align="right" valign="top" class="summary">
191 <span class="summary-type">&nbsp;</span>
192 </td><td class="summary">
193 <table width="100%" cellpadding="0" cellspacing="0" border="0">
194 <tr>
195 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#resumable" class="summary-sig-name">resumable</a>(<span class="summary-sig-arg">self</span>)</span><br />
196 Whether this upload is resumable.</td>
197 <td align="right" valign="top">
198 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.resumable">source&nbsp;code</a></span>
199
200 </td>
201 </tr>
202 </table>
203
204 </td>
205 </tr>
206<tr>
207 <td width="15%" align="right" valign="top" class="summary">
208 <span class="summary-type">&nbsp;</span>
209 </td><td class="summary">
210 <table width="100%" cellpadding="0" cellspacing="0" border="0">
211 <tr>
212 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#getbytes" class="summary-sig-name">getbytes</a>(<span class="summary-sig-arg">self</span>,
213 <span class="summary-sig-arg">begin</span>,
214 <span class="summary-sig-arg">length</span>)</span><br />
215 Get bytes from the media.</td>
216 <td align="right" valign="top">
217 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.getbytes">source&nbsp;code</a></span>
218
219 </td>
220 </tr>
221 </table>
222
223 </td>
224 </tr>
225<tr>
226 <td width="15%" align="right" valign="top" class="summary">
227 <span class="summary-type">&nbsp;</span>
228 </td><td class="summary">
229 <table width="100%" cellpadding="0" cellspacing="0" border="0">
230 <tr>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]231 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#has_stream" class="summary-sig-name">has_stream</a>(<span class="summary-sig-arg">self</span>)</span><br />
232 Does the underlying upload support a streaming interface.</td>
233 <td align="right" valign="top">
234 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.has_stream">source&nbsp;code</a></span>
235
236 </td>
237 </tr>
238 </table>
239
240 </td>
241 </tr>
242<tr>
243 <td width="15%" align="right" valign="top" class="summary">
244 <span class="summary-type">&nbsp;</span>
245 </td><td class="summary">
246 <table width="100%" cellpadding="0" cellspacing="0" border="0">
247 <tr>
248 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#stream" class="summary-sig-name">stream</a>(<span class="summary-sig-arg">self</span>)</span><br />
249 A stream interface to the data being uploaded.</td>
250 <td align="right" valign="top">
251 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.stream">source&nbsp;code</a></span>
252
253 </td>
254 </tr>
255 </table>
256
257 </td>
258 </tr>
259<tr>
260 <td width="15%" align="right" valign="top" class="summary">
261 <span class="summary-type">&nbsp;</span>
262 </td><td class="summary">
263 <table width="100%" cellpadding="0" cellspacing="0" border="0">
264 <tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]265 <td><span class="summary-sig"><a href="apiclient.http.MediaIoBaseUpload-class.html#to_json" class="summary-sig-name">to_json</a>(<span class="summary-sig-arg">self</span>)</span><br />
266 This upload type is not serializable.</td>
267 <td align="right" valign="top">
268 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.to_json">source&nbsp;code</a></span>
269
270 </td>
271 </tr>
272 </table>
273
274 </td>
275 </tr>
276 <tr>
277 <td colspan="2" class="summary">
278 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
279 <code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
280 </p></div>
281 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
282 <code>__delattr__</code>,
283 <code>__format__</code>,
284 <code>__getattribute__</code>,
285 <code>__hash__</code>,
286 <code>__new__</code>,
287 <code>__reduce__</code>,
288 <code>__reduce_ex__</code>,
289 <code>__repr__</code>,
290 <code>__setattr__</code>,
291 <code>__sizeof__</code>,
292 <code>__str__</code>,
293 <code>__subclasshook__</code>
294 </p>
295 </td>
296 </tr>
297</table>
298<!-- ==================== CLASS METHODS ==================== -->
299<a name="section-ClassMethods"></a>
300<table class="summary" border="1" cellpadding="3"
301 cellspacing="0" width="100%" bgcolor="white">
302<tr bgcolor="#70b0f0" class="table-header">
303 <td colspan="2" class="table-header">
304 <table border="0" cellpadding="0" cellspacing="0" width="100%">
305 <tr valign="top">
306 <td align="left"><span class="table-header">Class Methods</span></td>
307 <td align="right" valign="top"
308 ><span class="options">[<a href="#section-ClassMethods"
309 class="privatelink" onclick="toggle_private();"
310 >hide private</a>]</span></td>
311 </tr>
312 </table>
313 </td>
314</tr>
315 <tr>
316 <td colspan="2" class="summary">
317 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b>:
318 <code><a href="apiclient.http.MediaUpload-class.html#new_from_json">new_from_json</a></code>
319 </p>
320 </td>
321 </tr>
322</table>
323<!-- ==================== PROPERTIES ==================== -->
324<a name="section-Properties"></a>
325<table class="summary" border="1" cellpadding="3"
326 cellspacing="0" width="100%" bgcolor="white">
327<tr bgcolor="#70b0f0" class="table-header">
328 <td colspan="2" class="table-header">
329 <table border="0" cellpadding="0" cellspacing="0" width="100%">
330 <tr valign="top">
331 <td align="left"><span class="table-header">Properties</span></td>
332 <td align="right" valign="top"
333 ><span class="options">[<a href="#section-Properties"
334 class="privatelink" onclick="toggle_private();"
335 >hide private</a>]</span></td>
336 </tr>
337 </table>
338 </td>
339</tr>
340 <tr>
341 <td colspan="2" class="summary">
342 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
343 <code>__class__</code>
344 </p>
345 </td>
346 </tr>
347</table>
348<!-- ==================== METHOD DETAILS ==================== -->
349<a name="section-MethodDetails"></a>
350<table class="details" border="1" cellpadding="3"
351 cellspacing="0" width="100%" bgcolor="white">
352<tr bgcolor="#70b0f0" class="table-header">
353 <td colspan="2" class="table-header">
354 <table border="0" cellpadding="0" cellspacing="0" width="100%">
355 <tr valign="top">
356 <td align="left"><span class="table-header">Method Details</span></td>
357 <td align="right" valign="top"
358 ><span class="options">[<a href="#section-MethodDetails"
359 class="privatelink" onclick="toggle_private();"
360 >hide private</a>]</span></td>
361 </tr>
362 </table>
363 </td>
364</tr>
365</table>
366<a name="__init__"></a>
367<div>
368<table class="details" border="1" cellpadding="3"
369 cellspacing="0" width="100%" bgcolor="white">
370<tr><td>
371 <table width="100%" cellpadding="0" cellspacing="0" border="0">
372 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]373 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
374 <span class="sig-arg">fd</span>,
375 <span class="sig-arg">mimetype</span>,
376 <span class="sig-arg">chunksize</span>=<span class="sig-default">DEFAULT_CHUNK_SIZE</span>,
377 <span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]378 <br /><em class="fname">(Constructor)</em>
379 </h3>
380 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]381 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.__init__">source&nbsp;code</a></span>&nbsp;
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]382 </td>
383 </tr></table>
384
385 <pre class="literalblock">
386Constructor.
387
388Args:
Joe Gregoriofa08c2e2012-07-23 16:52:03 -0400[diff] [blame]389 fd: io.Base or file object, The source of the bytes to upload. MUST be
Joe Gregorio746096f2012-06-15 10:53:36 -0400[diff] [blame]390 opened in blocking mode, do not use streams opened in non-blocking mode.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]391 The given stream must be seekable, that is, it must be able to call
392 seek() on fd.
393 mimetype: string, Mime-type of the file.
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]394 chunksize: int, File will be uploaded in chunks of this many bytes. Only
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]395 used if resumable=True. Pass in a value of -1 if the file is to be
396 uploaded as a single chunk. Note that Google App Engine has a 5MB limit
397 on request size, so you should never set your chunksize larger than 5MB,
398 or to -1.
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]399 resumable: bool, True if this is a resumable upload. False means upload
400 in a single request.
401
402</pre>
403 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]404 <dt>Decorators:</dt>
405 <dd><ul class="nomargin-top">
406 <li><code>@util.positional(3)</code></li>
407 </ul></dd>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]408 <dt>Overrides:
409 object.__init__
410 </dt>
411 </dl>
412</td></tr></table>
413</div>
414<a name="chunksize"></a>
415<div>
416<table class="details" border="1" cellpadding="3"
417 cellspacing="0" width="100%" bgcolor="white">
418<tr><td>
419 <table width="100%" cellpadding="0" cellspacing="0" border="0">
420 <tr valign="top"><td>
421 <h3 class="epydoc"><span class="sig"><span class="sig-name">chunksize</span>(<span class="sig-arg">self</span>)</span>
422 </h3>
423 </td><td align="right" valign="top"
424 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.chunksize">source&nbsp;code</a></span>&nbsp;
425 </td>
426 </tr></table>
427
428 <pre class="literalblock">
429Chunk size for resumable uploads.
430
431Returns:
432 Chunk size in bytes.
433
434</pre>
435 <dl class="fields">
436 <dt>Overrides:
437 <a href="apiclient.http.MediaUpload-class.html#chunksize">MediaUpload.chunksize</a>
438 </dt>
439 </dl>
440</td></tr></table>
441</div>
442<a name="mimetype"></a>
443<div>
444<table class="details" border="1" cellpadding="3"
445 cellspacing="0" width="100%" bgcolor="white">
446<tr><td>
447 <table width="100%" cellpadding="0" cellspacing="0" border="0">
448 <tr valign="top"><td>
449 <h3 class="epydoc"><span class="sig"><span class="sig-name">mimetype</span>(<span class="sig-arg">self</span>)</span>
450 </h3>
451 </td><td align="right" valign="top"
452 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.mimetype">source&nbsp;code</a></span>&nbsp;
453 </td>
454 </tr></table>
455
456 <pre class="literalblock">
457Mime type of the body.
458
459Returns:
460 Mime type.
461
462</pre>
463 <dl class="fields">
464 <dt>Overrides:
465 <a href="apiclient.http.MediaUpload-class.html#mimetype">MediaUpload.mimetype</a>
466 </dt>
467 </dl>
468</td></tr></table>
469</div>
470<a name="size"></a>
471<div>
472<table class="details" border="1" cellpadding="3"
473 cellspacing="0" width="100%" bgcolor="white">
474<tr><td>
475 <table width="100%" cellpadding="0" cellspacing="0" border="0">
476 <tr valign="top"><td>
477 <h3 class="epydoc"><span class="sig"><span class="sig-name">size</span>(<span class="sig-arg">self</span>)</span>
478 </h3>
479 </td><td align="right" valign="top"
480 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.size">source&nbsp;code</a></span>&nbsp;
481 </td>
482 </tr></table>
483
484 <pre class="literalblock">
485Size of upload.
486
487Returns:
488 Size of the body, or None of the size is unknown.
489
490</pre>
491 <dl class="fields">
492 <dt>Overrides:
493 <a href="apiclient.http.MediaUpload-class.html#size">MediaUpload.size</a>
494 </dt>
495 </dl>
496</td></tr></table>
497</div>
498<a name="resumable"></a>
499<div>
500<table class="details" border="1" cellpadding="3"
501 cellspacing="0" width="100%" bgcolor="white">
502<tr><td>
503 <table width="100%" cellpadding="0" cellspacing="0" border="0">
504 <tr valign="top"><td>
505 <h3 class="epydoc"><span class="sig"><span class="sig-name">resumable</span>(<span class="sig-arg">self</span>)</span>
506 </h3>
507 </td><td align="right" valign="top"
508 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.resumable">source&nbsp;code</a></span>&nbsp;
509 </td>
510 </tr></table>
511
512 <pre class="literalblock">
513Whether this upload is resumable.
514
515Returns:
516 True if resumable upload or False.
517
518</pre>
519 <dl class="fields">
520 <dt>Overrides:
521 <a href="apiclient.http.MediaUpload-class.html#resumable">MediaUpload.resumable</a>
522 </dt>
523 </dl>
524</td></tr></table>
525</div>
526<a name="getbytes"></a>
527<div>
528<table class="details" border="1" cellpadding="3"
529 cellspacing="0" width="100%" bgcolor="white">
530<tr><td>
531 <table width="100%" cellpadding="0" cellspacing="0" border="0">
532 <tr valign="top"><td>
533 <h3 class="epydoc"><span class="sig"><span class="sig-name">getbytes</span>(<span class="sig-arg">self</span>,
534 <span class="sig-arg">begin</span>,
535 <span class="sig-arg">length</span>)</span>
536 </h3>
537 </td><td align="right" valign="top"
538 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.getbytes">source&nbsp;code</a></span>&nbsp;
539 </td>
540 </tr></table>
541
542 <pre class="literalblock">
543Get bytes from the media.
544
545Args:
546 begin: int, offset from beginning of file.
547 length: int, number of bytes to read, starting at begin.
548
549Returns:
550 A string of bytes read. May be shorted than length if EOF was reached
551 first.
552
553</pre>
554 <dl class="fields">
555 <dt>Overrides:
556 <a href="apiclient.http.MediaUpload-class.html#getbytes">MediaUpload.getbytes</a>
557 </dt>
558 </dl>
559</td></tr></table>
560</div>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]561<a name="has_stream"></a>
562<div>
563<table class="details" border="1" cellpadding="3"
564 cellspacing="0" width="100%" bgcolor="white">
565<tr><td>
566 <table width="100%" cellpadding="0" cellspacing="0" border="0">
567 <tr valign="top"><td>
568 <h3 class="epydoc"><span class="sig"><span class="sig-name">has_stream</span>(<span class="sig-arg">self</span>)</span>
569 </h3>
570 </td><td align="right" valign="top"
571 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.has_stream">source&nbsp;code</a></span>&nbsp;
572 </td>
573 </tr></table>
574
575 <pre class="literalblock">
576Does the underlying upload support a streaming interface.
577
578Streaming means it is an io.IOBase subclass that supports seek, i.e.
579seekable() returns True.
580
581Returns:
582 True if the call to stream() will return an instance of a seekable io.Base
583 subclass.
584
585</pre>
586 <dl class="fields">
587 <dt>Overrides:
588 <a href="apiclient.http.MediaUpload-class.html#has_stream">MediaUpload.has_stream</a>
589 </dt>
590 </dl>
591</td></tr></table>
592</div>
593<a name="stream"></a>
594<div>
595<table class="details" border="1" cellpadding="3"
596 cellspacing="0" width="100%" bgcolor="white">
597<tr><td>
598 <table width="100%" cellpadding="0" cellspacing="0" border="0">
599 <tr valign="top"><td>
600 <h3 class="epydoc"><span class="sig"><span class="sig-name">stream</span>(<span class="sig-arg">self</span>)</span>
601 </h3>
602 </td><td align="right" valign="top"
603 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.stream">source&nbsp;code</a></span>&nbsp;
604 </td>
605 </tr></table>
606
607 <pre class="literalblock">
608A stream interface to the data being uploaded.
609
610Returns:
611 The returned value is an io.IOBase subclass that supports seek, i.e.
612 seekable() returns True.
613
614</pre>
615 <dl class="fields">
616 <dt>Overrides:
617 <a href="apiclient.http.MediaUpload-class.html#stream">MediaUpload.stream</a>
618 </dt>
619 </dl>
620</td></tr></table>
621</div>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]622<a name="to_json"></a>
623<div>
624<table class="details" border="1" cellpadding="3"
625 cellspacing="0" width="100%" bgcolor="white">
626<tr><td>
627 <table width="100%" cellpadding="0" cellspacing="0" border="0">
628 <tr valign="top"><td>
629 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
630 </h3>
631 </td><td align="right" valign="top"
632 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.to_json">source&nbsp;code</a></span>&nbsp;
633 </td>
634 </tr></table>
635
636 <pre class="literalblock">
637This upload type is not serializable.
638
639</pre>
640 <dl class="fields">
641 <dt>Overrides:
642 <a href="apiclient.http.MediaUpload-class.html#to_json">MediaUpload.to_json</a>
643 </dt>
644 </dl>
645</td></tr></table>
646</div>
647<br />
648<!-- ==================== NAVIGATION BAR ==================== -->
649<table class="navbar" border="0" width="100%" cellpadding="0"
650 bgcolor="#a0c0ff" cellspacing="0">
651 <tr valign="middle">
652
653 <!-- Tree link -->
654 <th>&nbsp;&nbsp;&nbsp;<a
655 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
656
657 <!-- Index link -->
658 <th>&nbsp;&nbsp;&nbsp;<a
659 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
660
661 <!-- Help link -->
662 <th>&nbsp;&nbsp;&nbsp;<a
663 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
664
665 <th class="navbar" width="100%"></th>
666 </tr>
667</table>
668<table border="0" cellpadding="0" cellspacing="0" width="100%%">
669 <tr>
670 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]671 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:44 2013
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]672 </td>
673 <td align="right" class="footer">
674 <a target="mainFrame" href="http://epydoc.sourceforge.net"
675 >http://epydoc.sourceforge.net</a>
676 </td>
677 </tr>
678</table>
679
680<script type="text/javascript">
681 <!--
682 // Private objects are initially displayed (because if
683 // javascript is turned off then we want them to be
684 // visible); but by default, we want to hide them. So hide
685 // them unless we have a cookie that says to show them.
686 checkCookie();
687 // -->
688</script>
689</body>
690</html>