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