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