blob: ec58c260b4f5022b3496277fe41efd1086cbb9c8 [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 Gregorio746096f2012-06-15 10:53:36 -040059<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="5,61,141,88"/>
60<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="25,5,121,32"/>
Joe Gregorio66212032012-06-14 09:10:14 -040061</map>
Joe Gregorioebd0b842012-06-15 14:14:17 -040062 <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 -040063</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 -040072 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 -040075 farm.animals().insert(
76 id='cow',
77 name='cow.png',
Joe Gregorio66212032012-06-14 09:10:14 -040078 media_body=media).execute()
79
80</pre>
81
82<!-- ==================== INSTANCE METHODS ==================== -->
83<a name="section-InstanceMethods"></a>
84<table class="summary" border="1" cellpadding="3"
85 cellspacing="0" width="100%" bgcolor="white">
86<tr bgcolor="#70b0f0" class="table-header">
87 <td colspan="2" class="table-header">
88 <table border="0" cellpadding="0" cellspacing="0" width="100%">
89 <tr valign="top">
90 <td align="left"><span class="table-header">Instance Methods</span></td>
91 <td align="right" valign="top"
92 ><span class="options">[<a href="#section-InstanceMethods"
93 class="privatelink" onclick="toggle_private();"
94 >hide private</a>]</span></td>
95 </tr>
96 </table>
97 </td>
98</tr>
99<tr>
100 <td width="15%" align="right" valign="top" class="summary">
101 <span class="summary-type">&nbsp;</span>
102 </td><td class="summary">
103 <table width="100%" cellpadding="0" cellspacing="0" border="0">
104 <tr>
105 <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>,
106 <span class="summary-sig-arg">fh</span>,
107 <span class="summary-sig-arg">mimetype</span>,
108 <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">524288</span>,
109 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
110 Constructor.</td>
111 <td align="right" valign="top">
112 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.__init__">source&nbsp;code</a></span>
113
114 </td>
115 </tr>
116 </table>
117
118 </td>
119 </tr>
120<tr>
121 <td width="15%" align="right" valign="top" class="summary">
122 <span class="summary-type">&nbsp;</span>
123 </td><td class="summary">
124 <table width="100%" cellpadding="0" cellspacing="0" border="0">
125 <tr>
126 <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 />
127 Chunk size for resumable uploads.</td>
128 <td align="right" valign="top">
129 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.chunksize">source&nbsp;code</a></span>
130
131 </td>
132 </tr>
133 </table>
134
135 </td>
136 </tr>
137<tr>
138 <td width="15%" align="right" valign="top" class="summary">
139 <span class="summary-type">&nbsp;</span>
140 </td><td class="summary">
141 <table width="100%" cellpadding="0" cellspacing="0" border="0">
142 <tr>
143 <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 />
144 Mime type of the body.</td>
145 <td align="right" valign="top">
146 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.mimetype">source&nbsp;code</a></span>
147
148 </td>
149 </tr>
150 </table>
151
152 </td>
153 </tr>
154<tr>
155 <td width="15%" align="right" valign="top" class="summary">
156 <span class="summary-type">&nbsp;</span>
157 </td><td class="summary">
158 <table width="100%" cellpadding="0" cellspacing="0" border="0">
159 <tr>
160 <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 />
161 Size of upload.</td>
162 <td align="right" valign="top">
163 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.size">source&nbsp;code</a></span>
164
165 </td>
166 </tr>
167 </table>
168
169 </td>
170 </tr>
171<tr>
172 <td width="15%" align="right" valign="top" class="summary">
173 <span class="summary-type">&nbsp;</span>
174 </td><td class="summary">
175 <table width="100%" cellpadding="0" cellspacing="0" border="0">
176 <tr>
177 <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 />
178 Whether this upload is resumable.</td>
179 <td align="right" valign="top">
180 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.resumable">source&nbsp;code</a></span>
181
182 </td>
183 </tr>
184 </table>
185
186 </td>
187 </tr>
188<tr>
189 <td width="15%" align="right" valign="top" class="summary">
190 <span class="summary-type">&nbsp;</span>
191 </td><td class="summary">
192 <table width="100%" cellpadding="0" cellspacing="0" border="0">
193 <tr>
194 <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>,
195 <span class="summary-sig-arg">begin</span>,
196 <span class="summary-sig-arg">length</span>)</span><br />
197 Get bytes from the media.</td>
198 <td align="right" valign="top">
199 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.getbytes">source&nbsp;code</a></span>
200
201 </td>
202 </tr>
203 </table>
204
205 </td>
206 </tr>
207<tr>
208 <td width="15%" align="right" valign="top" class="summary">
209 <span class="summary-type">&nbsp;</span>
210 </td><td class="summary">
211 <table width="100%" cellpadding="0" cellspacing="0" border="0">
212 <tr>
213 <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 />
214 This upload type is not serializable.</td>
215 <td align="right" valign="top">
216 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.to_json">source&nbsp;code</a></span>
217
218 </td>
219 </tr>
220 </table>
221
222 </td>
223 </tr>
224 <tr>
225 <td colspan="2" class="summary">
226 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
227 <code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
228 </p></div>
229 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
230 <code>__delattr__</code>,
231 <code>__format__</code>,
232 <code>__getattribute__</code>,
233 <code>__hash__</code>,
234 <code>__new__</code>,
235 <code>__reduce__</code>,
236 <code>__reduce_ex__</code>,
237 <code>__repr__</code>,
238 <code>__setattr__</code>,
239 <code>__sizeof__</code>,
240 <code>__str__</code>,
241 <code>__subclasshook__</code>
242 </p>
243 </td>
244 </tr>
245</table>
246<!-- ==================== CLASS METHODS ==================== -->
247<a name="section-ClassMethods"></a>
248<table class="summary" border="1" cellpadding="3"
249 cellspacing="0" width="100%" bgcolor="white">
250<tr bgcolor="#70b0f0" class="table-header">
251 <td colspan="2" class="table-header">
252 <table border="0" cellpadding="0" cellspacing="0" width="100%">
253 <tr valign="top">
254 <td align="left"><span class="table-header">Class Methods</span></td>
255 <td align="right" valign="top"
256 ><span class="options">[<a href="#section-ClassMethods"
257 class="privatelink" onclick="toggle_private();"
258 >hide private</a>]</span></td>
259 </tr>
260 </table>
261 </td>
262</tr>
263 <tr>
264 <td colspan="2" class="summary">
265 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b>:
266 <code><a href="apiclient.http.MediaUpload-class.html#new_from_json">new_from_json</a></code>
267 </p>
268 </td>
269 </tr>
270</table>
271<!-- ==================== PROPERTIES ==================== -->
272<a name="section-Properties"></a>
273<table class="summary" border="1" cellpadding="3"
274 cellspacing="0" width="100%" bgcolor="white">
275<tr bgcolor="#70b0f0" class="table-header">
276 <td colspan="2" class="table-header">
277 <table border="0" cellpadding="0" cellspacing="0" width="100%">
278 <tr valign="top">
279 <td align="left"><span class="table-header">Properties</span></td>
280 <td align="right" valign="top"
281 ><span class="options">[<a href="#section-Properties"
282 class="privatelink" onclick="toggle_private();"
283 >hide private</a>]</span></td>
284 </tr>
285 </table>
286 </td>
287</tr>
288 <tr>
289 <td colspan="2" class="summary">
290 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
291 <code>__class__</code>
292 </p>
293 </td>
294 </tr>
295</table>
296<!-- ==================== METHOD DETAILS ==================== -->
297<a name="section-MethodDetails"></a>
298<table class="details" border="1" cellpadding="3"
299 cellspacing="0" width="100%" bgcolor="white">
300<tr bgcolor="#70b0f0" class="table-header">
301 <td colspan="2" class="table-header">
302 <table border="0" cellpadding="0" cellspacing="0" width="100%">
303 <tr valign="top">
304 <td align="left"><span class="table-header">Method Details</span></td>
305 <td align="right" valign="top"
306 ><span class="options">[<a href="#section-MethodDetails"
307 class="privatelink" onclick="toggle_private();"
308 >hide private</a>]</span></td>
309 </tr>
310 </table>
311 </td>
312</tr>
313</table>
314<a name="__init__"></a>
315<div>
316<table class="details" border="1" cellpadding="3"
317 cellspacing="0" width="100%" bgcolor="white">
318<tr><td>
319 <table width="100%" cellpadding="0" cellspacing="0" border="0">
320 <tr valign="top"><td>
321 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
322 <span class="sig-arg">fh</span>,
323 <span class="sig-arg">mimetype</span>,
324 <span class="sig-arg">chunksize</span>=<span class="sig-default">524288</span>,
325 <span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
326 <br /><em class="fname">(Constructor)</em>
327 </h3>
328 </td><td align="right" valign="top"
329 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.__init__">source&nbsp;code</a></span>&nbsp;
330 </td>
331 </tr></table>
332
333 <pre class="literalblock">
334Constructor.
335
336Args:
Joe Gregorio746096f2012-06-15 10:53:36 -0400337 fh: io.Base or file object, The source of the bytes to upload. MUST be
338 opened in blocking mode, do not use streams opened in non-blocking mode.
Joe Gregorio66212032012-06-14 09:10:14 -0400339 mimetype: string, Mime-type of the file. If None then a mime-type will be
340 guessed from the file extension.
341 chunksize: int, File will be uploaded in chunks of this many bytes. Only
342 used if resumable=True.
343 resumable: bool, True if this is a resumable upload. False means upload
344 in a single request.
345
346</pre>
347 <dl class="fields">
348 <dt>Overrides:
349 object.__init__
350 </dt>
351 </dl>
352</td></tr></table>
353</div>
354<a name="chunksize"></a>
355<div>
356<table class="details" border="1" cellpadding="3"
357 cellspacing="0" width="100%" bgcolor="white">
358<tr><td>
359 <table width="100%" cellpadding="0" cellspacing="0" border="0">
360 <tr valign="top"><td>
361 <h3 class="epydoc"><span class="sig"><span class="sig-name">chunksize</span>(<span class="sig-arg">self</span>)</span>
362 </h3>
363 </td><td align="right" valign="top"
364 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.chunksize">source&nbsp;code</a></span>&nbsp;
365 </td>
366 </tr></table>
367
368 <pre class="literalblock">
369Chunk size for resumable uploads.
370
371Returns:
372 Chunk size in bytes.
373
374</pre>
375 <dl class="fields">
376 <dt>Overrides:
377 <a href="apiclient.http.MediaUpload-class.html#chunksize">MediaUpload.chunksize</a>
378 </dt>
379 </dl>
380</td></tr></table>
381</div>
382<a name="mimetype"></a>
383<div>
384<table class="details" border="1" cellpadding="3"
385 cellspacing="0" width="100%" bgcolor="white">
386<tr><td>
387 <table width="100%" cellpadding="0" cellspacing="0" border="0">
388 <tr valign="top"><td>
389 <h3 class="epydoc"><span class="sig"><span class="sig-name">mimetype</span>(<span class="sig-arg">self</span>)</span>
390 </h3>
391 </td><td align="right" valign="top"
392 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.mimetype">source&nbsp;code</a></span>&nbsp;
393 </td>
394 </tr></table>
395
396 <pre class="literalblock">
397Mime type of the body.
398
399Returns:
400 Mime type.
401
402</pre>
403 <dl class="fields">
404 <dt>Overrides:
405 <a href="apiclient.http.MediaUpload-class.html#mimetype">MediaUpload.mimetype</a>
406 </dt>
407 </dl>
408</td></tr></table>
409</div>
410<a name="size"></a>
411<div>
412<table class="details" border="1" cellpadding="3"
413 cellspacing="0" width="100%" bgcolor="white">
414<tr><td>
415 <table width="100%" cellpadding="0" cellspacing="0" border="0">
416 <tr valign="top"><td>
417 <h3 class="epydoc"><span class="sig"><span class="sig-name">size</span>(<span class="sig-arg">self</span>)</span>
418 </h3>
419 </td><td align="right" valign="top"
420 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.size">source&nbsp;code</a></span>&nbsp;
421 </td>
422 </tr></table>
423
424 <pre class="literalblock">
425Size of upload.
426
427Returns:
428 Size of the body, or None of the size is unknown.
429
430</pre>
431 <dl class="fields">
432 <dt>Overrides:
433 <a href="apiclient.http.MediaUpload-class.html#size">MediaUpload.size</a>
434 </dt>
435 </dl>
436</td></tr></table>
437</div>
438<a name="resumable"></a>
439<div>
440<table class="details" border="1" cellpadding="3"
441 cellspacing="0" width="100%" bgcolor="white">
442<tr><td>
443 <table width="100%" cellpadding="0" cellspacing="0" border="0">
444 <tr valign="top"><td>
445 <h3 class="epydoc"><span class="sig"><span class="sig-name">resumable</span>(<span class="sig-arg">self</span>)</span>
446 </h3>
447 </td><td align="right" valign="top"
448 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.resumable">source&nbsp;code</a></span>&nbsp;
449 </td>
450 </tr></table>
451
452 <pre class="literalblock">
453Whether this upload is resumable.
454
455Returns:
456 True if resumable upload or False.
457
458</pre>
459 <dl class="fields">
460 <dt>Overrides:
461 <a href="apiclient.http.MediaUpload-class.html#resumable">MediaUpload.resumable</a>
462 </dt>
463 </dl>
464</td></tr></table>
465</div>
466<a name="getbytes"></a>
467<div>
468<table class="details" border="1" cellpadding="3"
469 cellspacing="0" width="100%" bgcolor="white">
470<tr><td>
471 <table width="100%" cellpadding="0" cellspacing="0" border="0">
472 <tr valign="top"><td>
473 <h3 class="epydoc"><span class="sig"><span class="sig-name">getbytes</span>(<span class="sig-arg">self</span>,
474 <span class="sig-arg">begin</span>,
475 <span class="sig-arg">length</span>)</span>
476 </h3>
477 </td><td align="right" valign="top"
478 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.getbytes">source&nbsp;code</a></span>&nbsp;
479 </td>
480 </tr></table>
481
482 <pre class="literalblock">
483Get bytes from the media.
484
485Args:
486 begin: int, offset from beginning of file.
487 length: int, number of bytes to read, starting at begin.
488
489Returns:
490 A string of bytes read. May be shorted than length if EOF was reached
491 first.
492
493</pre>
494 <dl class="fields">
495 <dt>Overrides:
496 <a href="apiclient.http.MediaUpload-class.html#getbytes">MediaUpload.getbytes</a>
497 </dt>
498 </dl>
499</td></tr></table>
500</div>
501<a name="to_json"></a>
502<div>
503<table class="details" border="1" cellpadding="3"
504 cellspacing="0" width="100%" bgcolor="white">
505<tr><td>
506 <table width="100%" cellpadding="0" cellspacing="0" border="0">
507 <tr valign="top"><td>
508 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
509 </h3>
510 </td><td align="right" valign="top"
511 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaIoBaseUpload.to_json">source&nbsp;code</a></span>&nbsp;
512 </td>
513 </tr></table>
514
515 <pre class="literalblock">
516This upload type is not serializable.
517
518</pre>
519 <dl class="fields">
520 <dt>Overrides:
521 <a href="apiclient.http.MediaUpload-class.html#to_json">MediaUpload.to_json</a>
522 </dt>
523 </dl>
524</td></tr></table>
525</div>
526<br />
527<!-- ==================== NAVIGATION BAR ==================== -->
528<table class="navbar" border="0" width="100%" cellpadding="0"
529 bgcolor="#a0c0ff" cellspacing="0">
530 <tr valign="middle">
531
532 <!-- Tree link -->
533 <th>&nbsp;&nbsp;&nbsp;<a
534 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
535
536 <!-- Index link -->
537 <th>&nbsp;&nbsp;&nbsp;<a
538 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
539
540 <!-- Help link -->
541 <th>&nbsp;&nbsp;&nbsp;<a
542 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
543
544 <th class="navbar" width="100%"></th>
545 </tr>
546</table>
547<table border="0" cellpadding="0" cellspacing="0" width="100%%">
548 <tr>
549 <td align="left" class="footer">
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400550 Generated by Epydoc 3.0.1 on Thu Jul 12 10:44:10 2012
Joe Gregorio66212032012-06-14 09:10:14 -0400551 </td>
552 <td align="right" class="footer">
553 <a target="mainFrame" href="http://epydoc.sourceforge.net"
554 >http://epydoc.sourceforge.net</a>
555 </td>
556 </tr>
557</table>
558
559<script type="text/javascript">
560 <!--
561 // Private objects are initially displayed (because if
562 // javascript is turned off then we want them to be
563 // visible); but by default, we want to hide them. So hide
564 // them unless we have a cookie that says to show them.
565 checkCookie();
566 // -->
567</script>
568</body>
569</html>