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