Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 44454e4c65dda5a2a811553e1cc540140c039fd5 / . / docs / epy / apiclient.http.MediaFileUpload-class.html
blob: 8fd8994f4875e10cd85f3694bc01f5068755b168 [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.MediaFileUpload</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;MediaFileUpload
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.MediaFileUpload-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 MediaFileUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_apiclien_17" name="uml_class_diagram_for_apiclien_17">
59<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#__init__" title="Constructor." alt="" coords="17,111,481,129"/>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]60<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="17,129,481,148"/>
61<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="17,148,481,167"/>
62<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#size" title="Size of upload." alt="" coords="17,167,481,185"/>
63<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="17,185,481,204"/>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]64<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="17,204,481,223"/>
65<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#to_json" title="Creating a JSON representation of an instance of Credentials." alt="" coords="17,223,481,241"/>
66<area shape="rect" href="apiclient.http.MediaFileUpload-class.html#from_json" title="apiclient.http.MediaFileUpload.from_json" alt="" coords="17,241,481,260"/>
67<area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="A MediaUpload for a file." alt="" coords="16,85,483,261"/>
68<area shape="rect" 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="183,36,316,55"/>
69<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="181,11,317,56"/>
70</map>
71 <img src="uml_class_diagram_for_apiclien_17.gif" alt='' usemap="#uml_class_diagram_for_apiclien_17" ismap="ismap" class="graph-without-title" />
72</center>
73</center>
74<hr />
75<pre class="literalblock">
76A MediaUpload for a file.
77
78Construct a MediaFileUpload and pass as the media_body parameter of the
79method. For example, if we had a service that allowed uploading images:
80
81
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]82 media = MediaFileUpload('smiley.png', mimetype='image/png',
83 chunksize=1024*1024, resumable=True)
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]84 service.objects().insert(
85 bucket=buckets['items'][0]['id'],
86 name='smiley.png',
87 media_body=media).execute()
88
89</pre>
90
91<!-- ==================== INSTANCE METHODS ==================== -->
92<a name="section-InstanceMethods"></a>
93<table class="summary" border="1" cellpadding="3"
94 cellspacing="0" width="100%" bgcolor="white">
95<tr bgcolor="#70b0f0" class="table-header">
96 <td colspan="2" class="table-header">
97 <table border="0" cellpadding="0" cellspacing="0" width="100%">
98 <tr valign="top">
99 <td align="left"><span class="table-header">Instance Methods</span></td>
100 <td align="right" valign="top"
101 ><span class="options">[<a href="#section-InstanceMethods"
102 class="privatelink" onclick="toggle_private();"
103 >hide private</a>]</span></td>
104 </tr>
105 </table>
106 </td>
107</tr>
108<tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <table width="100%" cellpadding="0" cellspacing="0" border="0">
113 <tr>
114 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
115 <span class="summary-sig-arg">filename</span>,
116 <span class="summary-sig-arg">mimetype</span>=<span class="summary-sig-default">None</span>,
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]117 <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">524288</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]118 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
119 Constructor.</td>
120 <td align="right" valign="top">
121 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source&nbsp;code</a></span>
122
123 </td>
124 </tr>
125 </table>
126
127 </td>
128 </tr>
129<tr>
130 <td width="15%" align="right" valign="top" class="summary">
131 <span class="summary-type">&nbsp;</span>
132 </td><td class="summary">
133 <table width="100%" cellpadding="0" cellspacing="0" border="0">
134 <tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]135 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#chunksize" class="summary-sig-name">chunksize</a>(<span class="summary-sig-arg">self</span>)</span><br />
136 Chunk size for resumable uploads.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]137 <td align="right" valign="top">
138 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source&nbsp;code</a></span>
139
140 </td>
141 </tr>
142 </table>
143
144 </td>
145 </tr>
146<tr>
147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type">&nbsp;</span>
149 </td><td class="summary">
150 <table width="100%" cellpadding="0" cellspacing="0" border="0">
151 <tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]152 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#mimetype" class="summary-sig-name">mimetype</a>(<span class="summary-sig-arg">self</span>)</span><br />
153 Mime type of the body.</td>
154 <td align="right" valign="top">
155 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source&nbsp;code</a></span>
156
157 </td>
158 </tr>
159 </table>
160
161 </td>
162 </tr>
163<tr>
164 <td width="15%" align="right" valign="top" class="summary">
165 <span class="summary-type">&nbsp;</span>
166 </td><td class="summary">
167 <table width="100%" cellpadding="0" cellspacing="0" border="0">
168 <tr>
169 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#size" class="summary-sig-name">size</a>(<span class="summary-sig-arg">self</span>)</span><br />
170 Size of upload.</td>
171 <td align="right" valign="top">
172 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source&nbsp;code</a></span>
173
174 </td>
175 </tr>
176 </table>
177
178 </td>
179 </tr>
180<tr>
181 <td width="15%" align="right" valign="top" class="summary">
182 <span class="summary-type">&nbsp;</span>
183 </td><td class="summary">
184 <table width="100%" cellpadding="0" cellspacing="0" border="0">
185 <tr>
186 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#resumable" class="summary-sig-name">resumable</a>(<span class="summary-sig-arg">self</span>)</span><br />
187 Whether this upload is resumable.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]188 <td align="right" valign="top">
189 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source&nbsp;code</a></span>
190
191 </td>
192 </tr>
193 </table>
194
195 </td>
196 </tr>
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.MediaFileUpload-class.html#getbytes" class="summary-sig-name">getbytes</a>(<span class="summary-sig-arg">self</span>,
204 <span class="summary-sig-arg">begin</span>,
205 <span class="summary-sig-arg">length</span>)</span><br />
206 Get bytes from the media.</td>
207 <td align="right" valign="top">
208 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source&nbsp;code</a></span>
209
210 </td>
211 </tr>
212 </table>
213
214 </td>
215 </tr>
216<tr>
217 <td width="15%" align="right" valign="top" class="summary">
218 <span class="summary-type">&nbsp;</span>
219 </td><td class="summary">
220 <table width="100%" cellpadding="0" cellspacing="0" border="0">
221 <tr>
222 <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#to_json" class="summary-sig-name">to_json</a>(<span class="summary-sig-arg">self</span>)</span><br />
223 Creating a JSON representation of an instance of Credentials.</td>
224 <td align="right" valign="top">
225 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.to_json">source&nbsp;code</a></span>
226
227 </td>
228 </tr>
229 </table>
230
231 </td>
232 </tr>
233 <tr>
234 <td colspan="2" class="summary">
235 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
236 <code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
237 </p></div>
238 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
239 <code>__delattr__</code>,
240 <code>__format__</code>,
241 <code>__getattribute__</code>,
242 <code>__hash__</code>,
243 <code>__new__</code>,
244 <code>__reduce__</code>,
245 <code>__reduce_ex__</code>,
246 <code>__repr__</code>,
247 <code>__setattr__</code>,
248 <code>__sizeof__</code>,
249 <code>__str__</code>,
250 <code>__subclasshook__</code>
251 </p>
252 </td>
253 </tr>
254</table>
255<!-- ==================== CLASS METHODS ==================== -->
256<a name="section-ClassMethods"></a>
257<table class="summary" border="1" cellpadding="3"
258 cellspacing="0" width="100%" bgcolor="white">
259<tr bgcolor="#70b0f0" class="table-header">
260 <td colspan="2" class="table-header">
261 <table border="0" cellpadding="0" cellspacing="0" width="100%">
262 <tr valign="top">
263 <td align="left"><span class="table-header">Class Methods</span></td>
264 <td align="right" valign="top"
265 ><span class="options">[<a href="#section-ClassMethods"
266 class="privatelink" onclick="toggle_private();"
267 >hide private</a>]</span></td>
268 </tr>
269 </table>
270 </td>
271</tr>
272 <tr>
273 <td colspan="2" class="summary">
274 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b>:
275 <code><a href="apiclient.http.MediaUpload-class.html#new_from_json">new_from_json</a></code>
276 </p>
277 </td>
278 </tr>
279</table>
280<!-- ==================== STATIC METHODS ==================== -->
281<a name="section-StaticMethods"></a>
282<table class="summary" border="1" cellpadding="3"
283 cellspacing="0" width="100%" bgcolor="white">
284<tr bgcolor="#70b0f0" class="table-header">
285 <td colspan="2" class="table-header">
286 <table border="0" cellpadding="0" cellspacing="0" width="100%">
287 <tr valign="top">
288 <td align="left"><span class="table-header">Static Methods</span></td>
289 <td align="right" valign="top"
290 ><span class="options">[<a href="#section-StaticMethods"
291 class="privatelink" onclick="toggle_private();"
292 >hide private</a>]</span></td>
293 </tr>
294 </table>
295 </td>
296</tr>
297<tr>
298 <td width="15%" align="right" valign="top" class="summary">
299 <span class="summary-type">&nbsp;</span>
300 </td><td class="summary">
301 <table width="100%" cellpadding="0" cellspacing="0" border="0">
302 <tr>
303 <td><span class="summary-sig"><a name="from_json"></a><span class="summary-sig-name">from_json</span>(<span class="summary-sig-arg">s</span>)</span></td>
304 <td align="right" valign="top">
305 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.from_json">source&nbsp;code</a></span>
306
307 </td>
308 </tr>
309 </table>
310
311 </td>
312 </tr>
313</table>
314<!-- ==================== PROPERTIES ==================== -->
315<a name="section-Properties"></a>
316<table class="summary" border="1" cellpadding="3"
317 cellspacing="0" width="100%" bgcolor="white">
318<tr bgcolor="#70b0f0" class="table-header">
319 <td colspan="2" class="table-header">
320 <table border="0" cellpadding="0" cellspacing="0" width="100%">
321 <tr valign="top">
322 <td align="left"><span class="table-header">Properties</span></td>
323 <td align="right" valign="top"
324 ><span class="options">[<a href="#section-Properties"
325 class="privatelink" onclick="toggle_private();"
326 >hide private</a>]</span></td>
327 </tr>
328 </table>
329 </td>
330</tr>
331 <tr>
332 <td colspan="2" class="summary">
333 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
334 <code>__class__</code>
335 </p>
336 </td>
337 </tr>
338</table>
339<!-- ==================== METHOD DETAILS ==================== -->
340<a name="section-MethodDetails"></a>
341<table class="details" border="1" cellpadding="3"
342 cellspacing="0" width="100%" bgcolor="white">
343<tr bgcolor="#70b0f0" class="table-header">
344 <td colspan="2" class="table-header">
345 <table border="0" cellpadding="0" cellspacing="0" width="100%">
346 <tr valign="top">
347 <td align="left"><span class="table-header">Method Details</span></td>
348 <td align="right" valign="top"
349 ><span class="options">[<a href="#section-MethodDetails"
350 class="privatelink" onclick="toggle_private();"
351 >hide private</a>]</span></td>
352 </tr>
353 </table>
354 </td>
355</tr>
356</table>
357<a name="__init__"></a>
358<div>
359<table class="details" border="1" cellpadding="3"
360 cellspacing="0" width="100%" bgcolor="white">
361<tr><td>
362 <table width="100%" cellpadding="0" cellspacing="0" border="0">
363 <tr valign="top"><td>
364 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
365 <span class="sig-arg">filename</span>,
366 <span class="sig-arg">mimetype</span>=<span class="sig-default">None</span>,
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]367 <span class="sig-arg">chunksize</span>=<span class="sig-default">524288</span>,
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]368 <span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
369 <br /><em class="fname">(Constructor)</em>
370 </h3>
371 </td><td align="right" valign="top"
372 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source&nbsp;code</a></span>&nbsp;
373 </td>
374 </tr></table>
375
376 <pre class="literalblock">
377Constructor.
378
379Args:
380 filename: string, Name of the file.
381 mimetype: string, Mime-type of the file. If None then a mime-type will be
382 guessed from the file extension.
383 chunksize: int, File will be uploaded in chunks of this many bytes. Only
384 used if resumable=True.
385 resumable: bool, True if this is a resumable upload. False means upload
386 in a single request.
387
388</pre>
389 <dl class="fields">
390 <dt>Overrides:
391 object.__init__
392 </dt>
393 </dl>
394</td></tr></table>
395</div>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]396<a name="chunksize"></a>
397<div>
398<table class="details" border="1" cellpadding="3"
399 cellspacing="0" width="100%" bgcolor="white">
400<tr><td>
401 <table width="100%" cellpadding="0" cellspacing="0" border="0">
402 <tr valign="top"><td>
403 <h3 class="epydoc"><span class="sig"><span class="sig-name">chunksize</span>(<span class="sig-arg">self</span>)</span>
404 </h3>
405 </td><td align="right" valign="top"
406 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source&nbsp;code</a></span>&nbsp;
407 </td>
408 </tr></table>
409
410 <pre class="literalblock">
411Chunk size for resumable uploads.
412
413Returns:
414 Chunk size in bytes.
415
416</pre>
417 <dl class="fields">
418 <dt>Overrides:
419 <a href="apiclient.http.MediaUpload-class.html#chunksize">MediaUpload.chunksize</a>
420 </dt>
421 </dl>
422</td></tr></table>
423</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]424<a name="mimetype"></a>
425<div>
426<table class="details" border="1" cellpadding="3"
427 cellspacing="0" width="100%" bgcolor="white">
428<tr><td>
429 <table width="100%" cellpadding="0" cellspacing="0" border="0">
430 <tr valign="top"><td>
431 <h3 class="epydoc"><span class="sig"><span class="sig-name">mimetype</span>(<span class="sig-arg">self</span>)</span>
432 </h3>
433 </td><td align="right" valign="top"
434 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source&nbsp;code</a></span>&nbsp;
435 </td>
436 </tr></table>
437
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]438 <pre class="literalblock">
439Mime type of the body.
440
441Returns:
442 Mime type.
443
444</pre>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]445 <dl class="fields">
446 <dt>Overrides:
447 <a href="apiclient.http.MediaUpload-class.html#mimetype">MediaUpload.mimetype</a>
448 </dt>
449 </dl>
450</td></tr></table>
451</div>
452<a name="size"></a>
453<div>
454<table class="details" border="1" cellpadding="3"
455 cellspacing="0" width="100%" bgcolor="white">
456<tr><td>
457 <table width="100%" cellpadding="0" cellspacing="0" border="0">
458 <tr valign="top"><td>
459 <h3 class="epydoc"><span class="sig"><span class="sig-name">size</span>(<span class="sig-arg">self</span>)</span>
460 </h3>
461 </td><td align="right" valign="top"
462 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source&nbsp;code</a></span>&nbsp;
463 </td>
464 </tr></table>
465
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]466 <pre class="literalblock">
467Size of upload.
468
469Returns:
470 Size of the body, or None of the size is unknown.
471
472</pre>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]473 <dl class="fields">
474 <dt>Overrides:
475 <a href="apiclient.http.MediaUpload-class.html#size">MediaUpload.size</a>
476 </dt>
477 </dl>
478</td></tr></table>
479</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]480<a name="resumable"></a>
481<div>
482<table class="details" border="1" cellpadding="3"
483 cellspacing="0" width="100%" bgcolor="white">
484<tr><td>
485 <table width="100%" cellpadding="0" cellspacing="0" border="0">
486 <tr valign="top"><td>
487 <h3 class="epydoc"><span class="sig"><span class="sig-name">resumable</span>(<span class="sig-arg">self</span>)</span>
488 </h3>
489 </td><td align="right" valign="top"
490 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source&nbsp;code</a></span>&nbsp;
491 </td>
492 </tr></table>
493
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]494 <pre class="literalblock">
495Whether this upload is resumable.
496
497Returns:
498 True if resumable upload or False.
499
500</pre>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]501 <dl class="fields">
502 <dt>Overrides:
503 <a href="apiclient.http.MediaUpload-class.html#resumable">MediaUpload.resumable</a>
504 </dt>
505 </dl>
506</td></tr></table>
507</div>
508<a name="getbytes"></a>
509<div>
510<table class="details" border="1" cellpadding="3"
511 cellspacing="0" width="100%" bgcolor="white">
512<tr><td>
513 <table width="100%" cellpadding="0" cellspacing="0" border="0">
514 <tr valign="top"><td>
515 <h3 class="epydoc"><span class="sig"><span class="sig-name">getbytes</span>(<span class="sig-arg">self</span>,
516 <span class="sig-arg">begin</span>,
517 <span class="sig-arg">length</span>)</span>
518 </h3>
519 </td><td align="right" valign="top"
520 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source&nbsp;code</a></span>&nbsp;
521 </td>
522 </tr></table>
523
524 <pre class="literalblock">
525Get bytes from the media.
526
527Args:
528 begin: int, offset from beginning of file.
529 length: int, number of bytes to read, starting at begin.
530
531Returns:
532 A string of bytes read. May be shorted than length if EOF was reached
533 first.
534
535</pre>
536 <dl class="fields">
537 <dt>Overrides:
538 <a href="apiclient.http.MediaUpload-class.html#getbytes">MediaUpload.getbytes</a>
539 </dt>
540 </dl>
541</td></tr></table>
542</div>
543<a name="to_json"></a>
544<div>
545<table class="details" border="1" cellpadding="3"
546 cellspacing="0" width="100%" bgcolor="white">
547<tr><td>
548 <table width="100%" cellpadding="0" cellspacing="0" border="0">
549 <tr valign="top"><td>
550 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
551 </h3>
552 </td><td align="right" valign="top"
553 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.to_json">source&nbsp;code</a></span>&nbsp;
554 </td>
555 </tr></table>
556
557 <pre class="literalblock">
558Creating a JSON representation of an instance of Credentials.
559
560Returns:
561 string, a JSON representation of this instance, suitable to pass to
562 from_json().
563
564</pre>
565 <dl class="fields">
566 <dt>Overrides:
567 <a href="apiclient.http.MediaUpload-class.html#to_json">MediaUpload.to_json</a>
568 </dt>
569 </dl>
570</td></tr></table>
571</div>
572<br />
573<!-- ==================== NAVIGATION BAR ==================== -->
574<table class="navbar" border="0" width="100%" cellpadding="0"
575 bgcolor="#a0c0ff" cellspacing="0">
576 <tr valign="middle">
577
578 <!-- Tree link -->
579 <th>&nbsp;&nbsp;&nbsp;<a
580 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
581
582 <!-- Index link -->
583 <th>&nbsp;&nbsp;&nbsp;<a
584 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
585
586 <!-- Help link -->
587 <th>&nbsp;&nbsp;&nbsp;<a
588 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
589
590 <th class="navbar" width="100%"></th>
591 </tr>
592</table>
593<table border="0" cellpadding="0" cellspacing="0" width="100%%">
594 <tr>
595 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]596 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]597 </td>
598 <td align="right" class="footer">
599 <a target="mainFrame" href="http://epydoc.sourceforge.net"
600 >http://epydoc.sourceforge.net</a>
601 </td>
602 </tr>
603</table>
604
605<script type="text/javascript">
606 <!--
607 // Private objects are initially displayed (because if
608 // javascript is turned off then we want them to be
609 // visible); but by default, we want to hide them. So hide
610 // them unless we have a cookie that says to show them.
611 checkCookie();
612 // -->
613</script>
614</body>
615</html>