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