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