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