Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / epy / googleapiclient.http.MediaFileUpload-class.html
blob: 75c3ef5649f8e8cfdf952eab1a3818e4a7d86ca6 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame^]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>googleapiclient.http.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 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="googleapiclient-module.html">Package&nbsp;googleapiclient</a> ::
41 <a href="googleapiclient.http-module.html">Module&nbsp;http</a> ::
42 Class&nbsp;MediaFileUpload
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="googleapiclient.http.MediaFileUpload-class.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57</table>
58<!-- ==================== CLASS DESCRIPTION ==================== -->
59<h1 class="epydoc">Class MediaFileUpload</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaFileUpload">source&nbsp;code</a></span></p>
60<center>
61<center> <map id="uml_class_diagram_for_googleap_25" name="uml_class_diagram_for_googleap_25">
62<area shape="rect" id="node67" href="googleapiclient.http.MediaFileUpload-class.html#__init__" title="Constructor." alt="" coords="17,305,597,324"/>
63<area shape="rect" id="node67" href="googleapiclient.http.MediaFileUpload-class.html#to_json" title="Creating a JSON representation of an instance of MediaFileUpload." alt="" coords="17,324,597,343"/>
64<area shape="rect" id="node67" href="googleapiclient.http.MediaFileUpload-class.html#from_json" title="googleapiclient.http.MediaFileUpload.from_json" alt="" coords="17,343,597,361"/>
65<area shape="rect" id="node1" href="googleapiclient.http.MediaFileUpload-class.html" title="A MediaUpload for a file." alt="" coords="5,273,608,367"/>
66<area shape="rect" id="node68" href="googleapiclient.http.MediaIoBaseUpload-class.html#chunksize" title="Chunk size for resumable uploads." alt="" coords="224,116,392,135"/>
67<area shape="rect" id="node68" href="googleapiclient.http.MediaIoBaseUpload-class.html#mimetype" title="Mime type of the body." alt="" coords="224,135,392,153"/>
68<area shape="rect" id="node68" href="googleapiclient.http.MediaIoBaseUpload-class.html#size" title="Size of upload." alt="" coords="224,153,392,172"/>
69<area shape="rect" id="node68" href="googleapiclient.http.MediaIoBaseUpload-class.html#resumable" title="Whether this upload is resumable." alt="" coords="224,172,392,191"/>
70<area shape="rect" id="node68" href="googleapiclient.http.MediaIoBaseUpload-class.html#getbytes" title="Get bytes from the media." alt="" coords="224,191,392,209"/>
71<area shape="rect" id="node68" href="googleapiclient.http.MediaIoBaseUpload-class.html#has_stream" title="Does the underlying upload support a streaming interface." alt="" coords="224,209,392,228"/>
72<area shape="rect" id="node68" href="googleapiclient.http.MediaIoBaseUpload-class.html#stream" title="A stream interface to the data being uploaded." alt="" coords="224,228,392,247"/>
73<area shape="rect" id="node2" href="googleapiclient.http.MediaIoBaseUpload-class.html" title="A MediaUpload for a io.Base objects." alt="" coords="212,83,404,253"/>
74<area shape="rect" id="node69" href="googleapiclient.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="240,39,376,57"/>
75<area shape="rect" id="node3" href="googleapiclient.http.MediaUpload-class.html" title="Describes a media object to upload." alt="" coords="228,6,388,63"/>
76</map>
77 <img src="uml_class_diagram_for_googleap_25.gif" alt='' usemap="#uml_class_diagram_for_googleap_25" ismap="ismap" class="graph-without-title" />
78</center>
79</center>
80<hr />
81<pre class="literalblock">
82A MediaUpload for a file.
83
84Construct a MediaFileUpload and pass as the media_body parameter of the
85method. For example, if we had a service that allowed uploading images:
86
87
88 media = MediaFileUpload('cow.png', mimetype='image/png',
89 chunksize=1024*1024, resumable=True)
90 farm.animals().insert(
91 id='cow',
92 name='cow.png',
93 media_body=media).execute()
94
95Depending on the platform you are working on, you may pass -1 as the
96chunksize, which indicates that the entire file should be uploaded in a single
97request. If the underlying platform supports streams, such as Python 2.6 or
98later, then this can be very efficient as it avoids multiple connections, and
99also avoids loading the entire file into memory before sending it. Note that
100Google App Engine has a 5MB limit on request size, so you should never set
101your chunksize larger than 5MB, or to -1.
102
103</pre>
104
105<!-- ==================== INSTANCE METHODS ==================== -->
106<a name="section-InstanceMethods"></a>
107<table class="summary" border="1" cellpadding="3"
108 cellspacing="0" width="100%" bgcolor="white">
109<tr bgcolor="#70b0f0" class="table-header">
110 <td colspan="2" class="table-header">
111 <table border="0" cellpadding="0" cellspacing="0" width="100%">
112 <tr valign="top">
113 <td align="left"><span class="table-header">Instance Methods</span></td>
114 <td align="right" valign="top"
115 ><span class="options">[<a href="#section-InstanceMethods"
116 class="privatelink" onclick="toggle_private();"
117 >hide private</a>]</span></td>
118 </tr>
119 </table>
120 </td>
121</tr>
122<tr>
123 <td width="15%" align="right" valign="top" class="summary">
124 <span class="summary-type">&nbsp;</span>
125 </td><td class="summary">
126 <table width="100%" cellpadding="0" cellspacing="0" border="0">
127 <tr>
128 <td><span class="summary-sig"><a href="googleapiclient.http.MediaFileUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
129 <span class="summary-sig-arg">filename</span>,
130 <span class="summary-sig-arg">mimetype</span>=<span class="summary-sig-default">None</span>,
131 <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">DEFAULT_CHUNK_SIZE</span>,
132 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
133 Constructor.</td>
134 <td align="right" valign="top">
135 <span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaFileUpload.__init__">source&nbsp;code</a></span>
136
137 </td>
138 </tr>
139 </table>
140
141 </td>
142 </tr>
143<tr>
144 <td width="15%" align="right" valign="top" class="summary">
145 <span class="summary-type">&nbsp;</span>
146 </td><td class="summary">
147 <table width="100%" cellpadding="0" cellspacing="0" border="0">
148 <tr>
149 <td><span class="summary-sig"><a href="googleapiclient.http.MediaFileUpload-class.html#to_json" class="summary-sig-name">to_json</a>(<span class="summary-sig-arg">self</span>)</span><br />
150 Creating a JSON representation of an instance of MediaFileUpload.</td>
151 <td align="right" valign="top">
152 <span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaFileUpload.to_json">source&nbsp;code</a></span>
153
154 </td>
155 </tr>
156 </table>
157
158 </td>
159 </tr>
160 <tr>
161 <td colspan="2" class="summary">
162 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="googleapiclient.http.MediaIoBaseUpload-class.html">MediaIoBaseUpload</a></code></b>:
163 <code><a href="googleapiclient.http.MediaIoBaseUpload-class.html#chunksize">chunksize</a></code>,
164 <code><a href="googleapiclient.http.MediaIoBaseUpload-class.html#getbytes">getbytes</a></code>,
165 <code><a href="googleapiclient.http.MediaIoBaseUpload-class.html#has_stream">has_stream</a></code>,
166 <code><a href="googleapiclient.http.MediaIoBaseUpload-class.html#mimetype">mimetype</a></code>,
167 <code><a href="googleapiclient.http.MediaIoBaseUpload-class.html#resumable">resumable</a></code>,
168 <code><a href="googleapiclient.http.MediaIoBaseUpload-class.html#size">size</a></code>,
169 <code><a href="googleapiclient.http.MediaIoBaseUpload-class.html#stream">stream</a></code>
170 </p>
171 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="googleapiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
172 <code><a href="googleapiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
173 </p></div>
174 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
175 <code>__delattr__</code>,
176 <code>__format__</code>,
177 <code>__getattribute__</code>,
178 <code>__hash__</code>,
179 <code>__new__</code>,
180 <code>__reduce__</code>,
181 <code>__reduce_ex__</code>,
182 <code>__repr__</code>,
183 <code>__setattr__</code>,
184 <code>__sizeof__</code>,
185 <code>__str__</code>,
186 <code>__subclasshook__</code>
187 </p>
188 </td>
189 </tr>
190</table>
191<!-- ==================== CLASS METHODS ==================== -->
192<a name="section-ClassMethods"></a>
193<table class="summary" border="1" cellpadding="3"
194 cellspacing="0" width="100%" bgcolor="white">
195<tr bgcolor="#70b0f0" class="table-header">
196 <td colspan="2" class="table-header">
197 <table border="0" cellpadding="0" cellspacing="0" width="100%">
198 <tr valign="top">
199 <td align="left"><span class="table-header">Class Methods</span></td>
200 <td align="right" valign="top"
201 ><span class="options">[<a href="#section-ClassMethods"
202 class="privatelink" onclick="toggle_private();"
203 >hide private</a>]</span></td>
204 </tr>
205 </table>
206 </td>
207</tr>
208 <tr>
209 <td colspan="2" class="summary">
210 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="googleapiclient.http.MediaUpload-class.html">MediaUpload</a></code></b>:
211 <code><a href="googleapiclient.http.MediaUpload-class.html#new_from_json">new_from_json</a></code>
212 </p>
213 </td>
214 </tr>
215</table>
216<!-- ==================== STATIC METHODS ==================== -->
217<a name="section-StaticMethods"></a>
218<table class="summary" border="1" cellpadding="3"
219 cellspacing="0" width="100%" bgcolor="white">
220<tr bgcolor="#70b0f0" class="table-header">
221 <td colspan="2" class="table-header">
222 <table border="0" cellpadding="0" cellspacing="0" width="100%">
223 <tr valign="top">
224 <td align="left"><span class="table-header">Static Methods</span></td>
225 <td align="right" valign="top"
226 ><span class="options">[<a href="#section-StaticMethods"
227 class="privatelink" onclick="toggle_private();"
228 >hide private</a>]</span></td>
229 </tr>
230 </table>
231 </td>
232</tr>
233<tr>
234 <td width="15%" align="right" valign="top" class="summary">
235 <span class="summary-type">&nbsp;</span>
236 </td><td class="summary">
237 <table width="100%" cellpadding="0" cellspacing="0" border="0">
238 <tr>
239 <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>
240 <td align="right" valign="top">
241 <span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaFileUpload.from_json">source&nbsp;code</a></span>
242
243 </td>
244 </tr>
245 </table>
246
247 </td>
248 </tr>
249</table>
250<!-- ==================== PROPERTIES ==================== -->
251<a name="section-Properties"></a>
252<table class="summary" border="1" cellpadding="3"
253 cellspacing="0" width="100%" bgcolor="white">
254<tr bgcolor="#70b0f0" class="table-header">
255 <td colspan="2" class="table-header">
256 <table border="0" cellpadding="0" cellspacing="0" width="100%">
257 <tr valign="top">
258 <td align="left"><span class="table-header">Properties</span></td>
259 <td align="right" valign="top"
260 ><span class="options">[<a href="#section-Properties"
261 class="privatelink" onclick="toggle_private();"
262 >hide private</a>]</span></td>
263 </tr>
264 </table>
265 </td>
266</tr>
267 <tr>
268 <td colspan="2" class="summary">
269 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
270 <code>__class__</code>
271 </p>
272 </td>
273 </tr>
274</table>
275<!-- ==================== METHOD DETAILS ==================== -->
276<a name="section-MethodDetails"></a>
277<table class="details" border="1" cellpadding="3"
278 cellspacing="0" width="100%" bgcolor="white">
279<tr bgcolor="#70b0f0" class="table-header">
280 <td colspan="2" class="table-header">
281 <table border="0" cellpadding="0" cellspacing="0" width="100%">
282 <tr valign="top">
283 <td align="left"><span class="table-header">Method Details</span></td>
284 <td align="right" valign="top"
285 ><span class="options">[<a href="#section-MethodDetails"
286 class="privatelink" onclick="toggle_private();"
287 >hide private</a>]</span></td>
288 </tr>
289 </table>
290 </td>
291</tr>
292</table>
293<a name="__init__"></a>
294<div>
295<table class="details" border="1" cellpadding="3"
296 cellspacing="0" width="100%" bgcolor="white">
297<tr><td>
298 <table width="100%" cellpadding="0" cellspacing="0" border="0">
299 <tr valign="top"><td>
300 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
301 <span class="sig-arg">filename</span>,
302 <span class="sig-arg">mimetype</span>=<span class="sig-default">None</span>,
303 <span class="sig-arg">chunksize</span>=<span class="sig-default">DEFAULT_CHUNK_SIZE</span>,
304 <span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
305 <br /><em class="fname">(Constructor)</em>
306 </h3>
307 </td><td align="right" valign="top"
308 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaFileUpload.__init__">source&nbsp;code</a></span>&nbsp;
309 </td>
310 </tr></table>
311
312 <pre class="literalblock">
313Constructor.
314
315Args:
316 filename: string, Name of the file.
317 mimetype: string, Mime-type of the file. If None then a mime-type will be
318 guessed from the file extension.
319 chunksize: int, File will be uploaded in chunks of this many bytes. Only
320 used if resumable=True. Pass in a value of -1 if the file is to be
321 uploaded in a single chunk. Note that Google App Engine has a 5MB limit
322 on request size, so you should never set your chunksize larger than 5MB,
323 or to -1.
324 resumable: bool, True if this is a resumable upload. False means upload
325 in a single request.
326
327</pre>
328 <dl class="fields">
329 <dt>Decorators:</dt>
330 <dd><ul class="nomargin-top">
331 <li><code>@util.positional(2)</code></li>
332 </ul></dd>
333 <dt>Overrides:
334 object.__init__
335 </dt>
336 </dl>
337</td></tr></table>
338</div>
339<a name="to_json"></a>
340<div>
341<table class="details" border="1" cellpadding="3"
342 cellspacing="0" width="100%" bgcolor="white">
343<tr><td>
344 <table width="100%" cellpadding="0" cellspacing="0" border="0">
345 <tr valign="top"><td>
346 <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span>
347 </h3>
348 </td><td align="right" valign="top"
349 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#MediaFileUpload.to_json">source&nbsp;code</a></span>&nbsp;
350 </td>
351 </tr></table>
352
353 <pre class="literalblock">
354Creating a JSON representation of an instance of MediaFileUpload.
355
356Returns:
357 string, a JSON representation of this instance, suitable to pass to
358 from_json().
359
360</pre>
361 <dl class="fields">
362 <dt>Overrides:
363 <a href="googleapiclient.http.MediaUpload-class.html#to_json">MediaUpload.to_json</a>
364 </dt>
365 </dl>
366</td></tr></table>
367</div>
368<br />
369<!-- ==================== NAVIGATION BAR ==================== -->
370<table class="navbar" border="0" width="100%" cellpadding="0"
371 bgcolor="#a0c0ff" cellspacing="0">
372 <tr valign="middle">
373 <!-- Home link -->
374 <th>&nbsp;&nbsp;&nbsp;<a
375 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
376
377 <!-- Tree link -->
378 <th>&nbsp;&nbsp;&nbsp;<a
379 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
380
381 <!-- Index link -->
382 <th>&nbsp;&nbsp;&nbsp;<a
383 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
384
385 <!-- Help link -->
386 <th>&nbsp;&nbsp;&nbsp;<a
387 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
388
389 <th class="navbar" width="100%"></th>
390 </tr>
391</table>
392<table border="0" cellpadding="0" cellspacing="0" width="100%%">
393 <tr>
394 <td align="left" class="footer">
395 Generated by Epydoc 3.0.1 on Thu Apr 24 15:46:10 2014
396 </td>
397 <td align="right" class="footer">
398 <a target="mainFrame" href="http://epydoc.sourceforge.net"
399 >http://epydoc.sourceforge.net</a>
400 </td>
401 </tr>
402</table>
403
404<script type="text/javascript">
405 <!--
406 // Private objects are initially displayed (because if
407 // javascript is turned off then we want them to be
408 // visible); but by default, we want to hide them. So hide
409 // them unless we have a cookie that says to show them.
410 checkCookie();
411 // -->
412</script>
413</body>
414</html>