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