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