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