| Joe Gregorio | 5dc0f5c | 2012-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>   <a | 
 | 20 |         href="module-tree.html">Trees</a>   </th> | 
 | 21 |  | 
 | 22 |   <!-- Index link --> | 
 | 23 |       <th>   <a | 
 | 24 |         href="identifier-index.html">Indices</a>   </th> | 
 | 25 |  | 
 | 26 |   <!-- Help link --> | 
 | 27 |       <th>   <a | 
 | 28 |         href="help.html">Help</a>   </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 apiclient</a> :: | 
 | 38 |         <a href="apiclient.http-module.html">Module http</a> :: | 
 | 39 |         Class 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 private</a>]</span></td></tr> | 
 | 47 |         <tr><td align="right"><span class="options" | 
 | 48 |             >[<a href="frames.html" target="_top">frames</a | 
 | 49 |             >] | <a href="apiclient.http.MediaFileUpload-class.html" | 
 | 50 |             target="_top">no 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 code</a></span></p> | 
 | 57 | <center> | 
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 58 | <center>  <map id="class_hierarchy_for_mediafileu" name="class_hierarchy_for_mediafileu"> | 
 | 59 | <area shape="rect" href="apiclient.http.MediaFileUpload-class.html" title="MediaFileUpload" alt="" coords="5,61,123,88"/> | 
 | 60 | <area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="16,5,112,32"/> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 61 | </map> | 
| Joe Gregorio | 746096f | 2012-06-15 10:53:36 -0400 | [diff] [blame] | 62 |   <img src="class_hierarchy_for_mediafileu.gif" alt='' usemap="#class_hierarchy_for_mediafileu" ismap="ismap" class="graph-without-title" /> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 63 | </center> | 
 | 64 | </center> | 
 | 65 | <hr /> | 
 | 66 | <pre class="literalblock"> | 
 | 67 | A MediaUpload for a file. | 
 | 68 |  | 
 | 69 | Construct a MediaFileUpload and pass as the media_body parameter of the | 
 | 70 | method. For example, if we had a service that allowed uploading images: | 
 | 71 |  | 
 | 72 |  | 
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 73 |   media = MediaFileUpload('cow.png', mimetype='image/png', | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 74 |     chunksize=1024*1024, resumable=True) | 
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 75 |   farm.animals()..insert( | 
 | 76 |       id='cow', | 
 | 77 |       name='cow.png', | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 78 |       media_body=media).execute() | 
 | 79 |  | 
 | 80 | </pre> | 
 | 81 |  | 
 | 82 | <!-- ==================== INSTANCE METHODS ==================== --> | 
 | 83 | <a name="section-InstanceMethods"></a> | 
 | 84 | <table class="summary" border="1" cellpadding="3" | 
 | 85 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 86 | <tr bgcolor="#70b0f0" class="table-header"> | 
 | 87 |   <td colspan="2" class="table-header"> | 
 | 88 |     <table border="0" cellpadding="0" cellspacing="0" width="100%"> | 
 | 89 |       <tr valign="top"> | 
 | 90 |         <td align="left"><span class="table-header">Instance Methods</span></td> | 
 | 91 |         <td align="right" valign="top" | 
 | 92 |          ><span class="options">[<a href="#section-InstanceMethods" | 
 | 93 |          class="privatelink" onclick="toggle_private();" | 
 | 94 |          >hide private</a>]</span></td> | 
 | 95 |       </tr> | 
 | 96 |     </table> | 
 | 97 |   </td> | 
 | 98 | </tr> | 
 | 99 | <tr> | 
 | 100 |     <td width="15%" align="right" valign="top" class="summary"> | 
 | 101 |       <span class="summary-type"> </span> | 
 | 102 |     </td><td class="summary"> | 
 | 103 |       <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 104 |         <tr> | 
 | 105 |           <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>, | 
 | 106 |         <span class="summary-sig-arg">filename</span>, | 
 | 107 |         <span class="summary-sig-arg">mimetype</span>=<span class="summary-sig-default">None</span>, | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 108 |         <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">524288</span>, | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 109 |         <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br /> | 
 | 110 |       Constructor.</td> | 
 | 111 |           <td align="right" valign="top"> | 
 | 112 |             <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source code</a></span> | 
 | 113 |              | 
 | 114 |           </td> | 
 | 115 |         </tr> | 
 | 116 |       </table> | 
 | 117 |        | 
 | 118 |     </td> | 
 | 119 |   </tr> | 
 | 120 | <tr> | 
 | 121 |     <td width="15%" align="right" valign="top" class="summary"> | 
 | 122 |       <span class="summary-type"> </span> | 
 | 123 |     </td><td class="summary"> | 
 | 124 |       <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 125 |         <tr> | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 126 |           <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#chunksize" class="summary-sig-name">chunksize</a>(<span class="summary-sig-arg">self</span>)</span><br /> | 
 | 127 |       Chunk size for resumable uploads.</td> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 128 |           <td align="right" valign="top"> | 
 | 129 |             <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source code</a></span> | 
 | 130 |              | 
 | 131 |           </td> | 
 | 132 |         </tr> | 
 | 133 |       </table> | 
 | 134 |        | 
 | 135 |     </td> | 
 | 136 |   </tr> | 
 | 137 | <tr> | 
 | 138 |     <td width="15%" align="right" valign="top" class="summary"> | 
 | 139 |       <span class="summary-type"> </span> | 
 | 140 |     </td><td class="summary"> | 
 | 141 |       <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 142 |         <tr> | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 143 |           <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#mimetype" class="summary-sig-name">mimetype</a>(<span class="summary-sig-arg">self</span>)</span><br /> | 
 | 144 |       Mime type of the body.</td> | 
 | 145 |           <td align="right" valign="top"> | 
 | 146 |             <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source code</a></span> | 
 | 147 |              | 
 | 148 |           </td> | 
 | 149 |         </tr> | 
 | 150 |       </table> | 
 | 151 |        | 
 | 152 |     </td> | 
 | 153 |   </tr> | 
 | 154 | <tr> | 
 | 155 |     <td width="15%" align="right" valign="top" class="summary"> | 
 | 156 |       <span class="summary-type"> </span> | 
 | 157 |     </td><td class="summary"> | 
 | 158 |       <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 159 |         <tr> | 
 | 160 |           <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#size" class="summary-sig-name">size</a>(<span class="summary-sig-arg">self</span>)</span><br /> | 
 | 161 |       Size of upload.</td> | 
 | 162 |           <td align="right" valign="top"> | 
 | 163 |             <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source code</a></span> | 
 | 164 |              | 
 | 165 |           </td> | 
 | 166 |         </tr> | 
 | 167 |       </table> | 
 | 168 |        | 
 | 169 |     </td> | 
 | 170 |   </tr> | 
 | 171 | <tr> | 
 | 172 |     <td width="15%" align="right" valign="top" class="summary"> | 
 | 173 |       <span class="summary-type"> </span> | 
 | 174 |     </td><td class="summary"> | 
 | 175 |       <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 176 |         <tr> | 
 | 177 |           <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#resumable" class="summary-sig-name">resumable</a>(<span class="summary-sig-arg">self</span>)</span><br /> | 
 | 178 |       Whether this upload is resumable.</td> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 179 |           <td align="right" valign="top"> | 
 | 180 |             <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source code</a></span> | 
 | 181 |              | 
 | 182 |           </td> | 
 | 183 |         </tr> | 
 | 184 |       </table> | 
 | 185 |        | 
 | 186 |     </td> | 
 | 187 |   </tr> | 
 | 188 | <tr> | 
 | 189 |     <td width="15%" align="right" valign="top" class="summary"> | 
 | 190 |       <span class="summary-type"> </span> | 
 | 191 |     </td><td class="summary"> | 
 | 192 |       <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 193 |         <tr> | 
 | 194 |           <td><span class="summary-sig"><a href="apiclient.http.MediaFileUpload-class.html#getbytes" class="summary-sig-name">getbytes</a>(<span class="summary-sig-arg">self</span>, | 
 | 195 |         <span class="summary-sig-arg">begin</span>, | 
 | 196 |         <span class="summary-sig-arg">length</span>)</span><br /> | 
 | 197 |       Get bytes from the media.</td> | 
 | 198 |           <td align="right" valign="top"> | 
 | 199 |             <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source code</a></span> | 
 | 200 |              | 
 | 201 |           </td> | 
 | 202 |         </tr> | 
 | 203 |       </table> | 
 | 204 |        | 
 | 205 |     </td> | 
 | 206 |   </tr> | 
 | 207 | <tr> | 
 | 208 |     <td width="15%" align="right" valign="top" class="summary"> | 
 | 209 |       <span class="summary-type"> </span> | 
 | 210 |     </td><td class="summary"> | 
 | 211 |       <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 212 |         <tr> | 
 | 213 |           <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 Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 214 |       Creating a JSON representation of an instance of MediaFileUpload.</td> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 215 |           <td align="right" valign="top"> | 
 | 216 |             <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.to_json">source code</a></span> | 
 | 217 |              | 
 | 218 |           </td> | 
 | 219 |         </tr> | 
 | 220 |       </table> | 
 | 221 |        | 
 | 222 |     </td> | 
 | 223 |   </tr> | 
 | 224 |   <tr> | 
 | 225 |     <td colspan="2" class="summary"> | 
 | 226 |     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private): | 
 | 227 |       <code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code> | 
 | 228 |       </p></div> | 
 | 229 |     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: | 
 | 230 |       <code>__delattr__</code>, | 
 | 231 |       <code>__format__</code>, | 
 | 232 |       <code>__getattribute__</code>, | 
 | 233 |       <code>__hash__</code>, | 
 | 234 |       <code>__new__</code>, | 
 | 235 |       <code>__reduce__</code>, | 
 | 236 |       <code>__reduce_ex__</code>, | 
 | 237 |       <code>__repr__</code>, | 
 | 238 |       <code>__setattr__</code>, | 
 | 239 |       <code>__sizeof__</code>, | 
 | 240 |       <code>__str__</code>, | 
 | 241 |       <code>__subclasshook__</code> | 
 | 242 |       </p> | 
 | 243 |     </td> | 
 | 244 |   </tr> | 
 | 245 | </table> | 
 | 246 | <!-- ==================== CLASS METHODS ==================== --> | 
 | 247 | <a name="section-ClassMethods"></a> | 
 | 248 | <table class="summary" border="1" cellpadding="3" | 
 | 249 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 250 | <tr bgcolor="#70b0f0" class="table-header"> | 
 | 251 |   <td colspan="2" class="table-header"> | 
 | 252 |     <table border="0" cellpadding="0" cellspacing="0" width="100%"> | 
 | 253 |       <tr valign="top"> | 
 | 254 |         <td align="left"><span class="table-header">Class Methods</span></td> | 
 | 255 |         <td align="right" valign="top" | 
 | 256 |          ><span class="options">[<a href="#section-ClassMethods" | 
 | 257 |          class="privatelink" onclick="toggle_private();" | 
 | 258 |          >hide private</a>]</span></td> | 
 | 259 |       </tr> | 
 | 260 |     </table> | 
 | 261 |   </td> | 
 | 262 | </tr> | 
 | 263 |   <tr> | 
 | 264 |     <td colspan="2" class="summary"> | 
 | 265 |     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b>: | 
 | 266 |       <code><a href="apiclient.http.MediaUpload-class.html#new_from_json">new_from_json</a></code> | 
 | 267 |       </p> | 
 | 268 |     </td> | 
 | 269 |   </tr> | 
 | 270 | </table> | 
 | 271 | <!-- ==================== STATIC METHODS ==================== --> | 
 | 272 | <a name="section-StaticMethods"></a> | 
 | 273 | <table class="summary" border="1" cellpadding="3" | 
 | 274 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 275 | <tr bgcolor="#70b0f0" class="table-header"> | 
 | 276 |   <td colspan="2" class="table-header"> | 
 | 277 |     <table border="0" cellpadding="0" cellspacing="0" width="100%"> | 
 | 278 |       <tr valign="top"> | 
 | 279 |         <td align="left"><span class="table-header">Static Methods</span></td> | 
 | 280 |         <td align="right" valign="top" | 
 | 281 |          ><span class="options">[<a href="#section-StaticMethods" | 
 | 282 |          class="privatelink" onclick="toggle_private();" | 
 | 283 |          >hide private</a>]</span></td> | 
 | 284 |       </tr> | 
 | 285 |     </table> | 
 | 286 |   </td> | 
 | 287 | </tr> | 
 | 288 | <tr> | 
 | 289 |     <td width="15%" align="right" valign="top" class="summary"> | 
 | 290 |       <span class="summary-type"> </span> | 
 | 291 |     </td><td class="summary"> | 
 | 292 |       <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 293 |         <tr> | 
 | 294 |           <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> | 
 | 295 |           <td align="right" valign="top"> | 
 | 296 |             <span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.from_json">source code</a></span> | 
 | 297 |              | 
 | 298 |           </td> | 
 | 299 |         </tr> | 
 | 300 |       </table> | 
 | 301 |        | 
 | 302 |     </td> | 
 | 303 |   </tr> | 
 | 304 | </table> | 
 | 305 | <!-- ==================== PROPERTIES ==================== --> | 
 | 306 | <a name="section-Properties"></a> | 
 | 307 | <table class="summary" border="1" cellpadding="3" | 
 | 308 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 309 | <tr bgcolor="#70b0f0" class="table-header"> | 
 | 310 |   <td colspan="2" class="table-header"> | 
 | 311 |     <table border="0" cellpadding="0" cellspacing="0" width="100%"> | 
 | 312 |       <tr valign="top"> | 
 | 313 |         <td align="left"><span class="table-header">Properties</span></td> | 
 | 314 |         <td align="right" valign="top" | 
 | 315 |          ><span class="options">[<a href="#section-Properties" | 
 | 316 |          class="privatelink" onclick="toggle_private();" | 
 | 317 |          >hide private</a>]</span></td> | 
 | 318 |       </tr> | 
 | 319 |     </table> | 
 | 320 |   </td> | 
 | 321 | </tr> | 
 | 322 |   <tr> | 
 | 323 |     <td colspan="2" class="summary"> | 
 | 324 |     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: | 
 | 325 |       <code>__class__</code> | 
 | 326 |       </p> | 
 | 327 |     </td> | 
 | 328 |   </tr> | 
 | 329 | </table> | 
 | 330 | <!-- ==================== METHOD DETAILS ==================== --> | 
 | 331 | <a name="section-MethodDetails"></a> | 
 | 332 | <table class="details" border="1" cellpadding="3" | 
 | 333 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 334 | <tr bgcolor="#70b0f0" class="table-header"> | 
 | 335 |   <td colspan="2" class="table-header"> | 
 | 336 |     <table border="0" cellpadding="0" cellspacing="0" width="100%"> | 
 | 337 |       <tr valign="top"> | 
 | 338 |         <td align="left"><span class="table-header">Method Details</span></td> | 
 | 339 |         <td align="right" valign="top" | 
 | 340 |          ><span class="options">[<a href="#section-MethodDetails" | 
 | 341 |          class="privatelink" onclick="toggle_private();" | 
 | 342 |          >hide private</a>]</span></td> | 
 | 343 |       </tr> | 
 | 344 |     </table> | 
 | 345 |   </td> | 
 | 346 | </tr> | 
 | 347 | </table> | 
 | 348 | <a name="__init__"></a> | 
 | 349 | <div> | 
 | 350 | <table class="details" border="1" cellpadding="3" | 
 | 351 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 352 | <tr><td> | 
 | 353 |   <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 354 |   <tr valign="top"><td> | 
 | 355 |   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, | 
 | 356 |         <span class="sig-arg">filename</span>, | 
 | 357 |         <span class="sig-arg">mimetype</span>=<span class="sig-default">None</span>, | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 358 |         <span class="sig-arg">chunksize</span>=<span class="sig-default">524288</span>, | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 359 |         <span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span> | 
 | 360 |     <br /><em class="fname">(Constructor)</em> | 
 | 361 |   </h3> | 
 | 362 |   </td><td align="right" valign="top" | 
 | 363 |     ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.__init__">source code</a></span>  | 
 | 364 |     </td> | 
 | 365 |   </tr></table> | 
 | 366 |    | 
 | 367 |   <pre class="literalblock"> | 
 | 368 | Constructor. | 
 | 369 |  | 
 | 370 | Args: | 
 | 371 |   filename: string, Name of the file. | 
 | 372 |   mimetype: string, Mime-type of the file. If None then a mime-type will be | 
 | 373 |     guessed from the file extension. | 
 | 374 |   chunksize: int, File will be uploaded in chunks of this many bytes. Only | 
 | 375 |     used if resumable=True. | 
 | 376 |   resumable: bool, True if this is a resumable upload. False means upload | 
 | 377 |     in a single request. | 
 | 378 |  | 
 | 379 | </pre> | 
 | 380 |   <dl class="fields"> | 
 | 381 |     <dt>Overrides: | 
 | 382 |         object.__init__ | 
 | 383 |     </dt> | 
 | 384 |   </dl> | 
 | 385 | </td></tr></table> | 
 | 386 | </div> | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 387 | <a name="chunksize"></a> | 
 | 388 | <div> | 
 | 389 | <table class="details" border="1" cellpadding="3" | 
 | 390 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 391 | <tr><td> | 
 | 392 |   <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 393 |   <tr valign="top"><td> | 
 | 394 |   <h3 class="epydoc"><span class="sig"><span class="sig-name">chunksize</span>(<span class="sig-arg">self</span>)</span> | 
 | 395 |   </h3> | 
 | 396 |   </td><td align="right" valign="top" | 
 | 397 |     ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.chunksize">source code</a></span>  | 
 | 398 |     </td> | 
 | 399 |   </tr></table> | 
 | 400 |    | 
 | 401 |   <pre class="literalblock"> | 
 | 402 | Chunk size for resumable uploads. | 
 | 403 |  | 
 | 404 | Returns: | 
 | 405 |   Chunk size in bytes. | 
 | 406 |  | 
 | 407 | </pre> | 
 | 408 |   <dl class="fields"> | 
 | 409 |     <dt>Overrides: | 
 | 410 |         <a href="apiclient.http.MediaUpload-class.html#chunksize">MediaUpload.chunksize</a> | 
 | 411 |     </dt> | 
 | 412 |   </dl> | 
 | 413 | </td></tr></table> | 
 | 414 | </div> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 415 | <a name="mimetype"></a> | 
 | 416 | <div> | 
 | 417 | <table class="details" border="1" cellpadding="3" | 
 | 418 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 419 | <tr><td> | 
 | 420 |   <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 421 |   <tr valign="top"><td> | 
 | 422 |   <h3 class="epydoc"><span class="sig"><span class="sig-name">mimetype</span>(<span class="sig-arg">self</span>)</span> | 
 | 423 |   </h3> | 
 | 424 |   </td><td align="right" valign="top" | 
 | 425 |     ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.mimetype">source code</a></span>  | 
 | 426 |     </td> | 
 | 427 |   </tr></table> | 
 | 428 |    | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 429 |   <pre class="literalblock"> | 
 | 430 | Mime type of the body. | 
 | 431 |  | 
 | 432 | Returns: | 
 | 433 |   Mime type. | 
 | 434 |  | 
 | 435 | </pre> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 436 |   <dl class="fields"> | 
 | 437 |     <dt>Overrides: | 
 | 438 |         <a href="apiclient.http.MediaUpload-class.html#mimetype">MediaUpload.mimetype</a> | 
 | 439 |     </dt> | 
 | 440 |   </dl> | 
 | 441 | </td></tr></table> | 
 | 442 | </div> | 
 | 443 | <a name="size"></a> | 
 | 444 | <div> | 
 | 445 | <table class="details" border="1" cellpadding="3" | 
 | 446 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 447 | <tr><td> | 
 | 448 |   <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 449 |   <tr valign="top"><td> | 
 | 450 |   <h3 class="epydoc"><span class="sig"><span class="sig-name">size</span>(<span class="sig-arg">self</span>)</span> | 
 | 451 |   </h3> | 
 | 452 |   </td><td align="right" valign="top" | 
 | 453 |     ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.size">source code</a></span>  | 
 | 454 |     </td> | 
 | 455 |   </tr></table> | 
 | 456 |    | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 457 |   <pre class="literalblock"> | 
 | 458 | Size of upload. | 
 | 459 |  | 
 | 460 | Returns: | 
 | 461 |   Size of the body, or None of the size is unknown. | 
 | 462 |  | 
 | 463 | </pre> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 464 |   <dl class="fields"> | 
 | 465 |     <dt>Overrides: | 
 | 466 |         <a href="apiclient.http.MediaUpload-class.html#size">MediaUpload.size</a> | 
 | 467 |     </dt> | 
 | 468 |   </dl> | 
 | 469 | </td></tr></table> | 
 | 470 | </div> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 471 | <a name="resumable"></a> | 
 | 472 | <div> | 
 | 473 | <table class="details" border="1" cellpadding="3" | 
 | 474 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 475 | <tr><td> | 
 | 476 |   <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 477 |   <tr valign="top"><td> | 
 | 478 |   <h3 class="epydoc"><span class="sig"><span class="sig-name">resumable</span>(<span class="sig-arg">self</span>)</span> | 
 | 479 |   </h3> | 
 | 480 |   </td><td align="right" valign="top" | 
 | 481 |     ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.resumable">source code</a></span>  | 
 | 482 |     </td> | 
 | 483 |   </tr></table> | 
 | 484 |    | 
| Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 485 |   <pre class="literalblock"> | 
 | 486 | Whether this upload is resumable. | 
 | 487 |  | 
 | 488 | Returns: | 
 | 489 |   True if resumable upload or False. | 
 | 490 |  | 
 | 491 | </pre> | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 492 |   <dl class="fields"> | 
 | 493 |     <dt>Overrides: | 
 | 494 |         <a href="apiclient.http.MediaUpload-class.html#resumable">MediaUpload.resumable</a> | 
 | 495 |     </dt> | 
 | 496 |   </dl> | 
 | 497 | </td></tr></table> | 
 | 498 | </div> | 
 | 499 | <a name="getbytes"></a> | 
 | 500 | <div> | 
 | 501 | <table class="details" border="1" cellpadding="3" | 
 | 502 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 503 | <tr><td> | 
 | 504 |   <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 505 |   <tr valign="top"><td> | 
 | 506 |   <h3 class="epydoc"><span class="sig"><span class="sig-name">getbytes</span>(<span class="sig-arg">self</span>, | 
 | 507 |         <span class="sig-arg">begin</span>, | 
 | 508 |         <span class="sig-arg">length</span>)</span> | 
 | 509 |   </h3> | 
 | 510 |   </td><td align="right" valign="top" | 
 | 511 |     ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.getbytes">source code</a></span>  | 
 | 512 |     </td> | 
 | 513 |   </tr></table> | 
 | 514 |    | 
 | 515 |   <pre class="literalblock"> | 
 | 516 | Get bytes from the media. | 
 | 517 |  | 
 | 518 | Args: | 
 | 519 |   begin: int, offset from beginning of file. | 
 | 520 |   length: int, number of bytes to read, starting at begin. | 
 | 521 |  | 
 | 522 | Returns: | 
 | 523 |   A string of bytes read. May be shorted than length if EOF was reached | 
 | 524 |   first. | 
 | 525 |  | 
 | 526 | </pre> | 
 | 527 |   <dl class="fields"> | 
 | 528 |     <dt>Overrides: | 
 | 529 |         <a href="apiclient.http.MediaUpload-class.html#getbytes">MediaUpload.getbytes</a> | 
 | 530 |     </dt> | 
 | 531 |   </dl> | 
 | 532 | </td></tr></table> | 
 | 533 | </div> | 
 | 534 | <a name="to_json"></a> | 
 | 535 | <div> | 
 | 536 | <table class="details" border="1" cellpadding="3" | 
 | 537 |        cellspacing="0" width="100%" bgcolor="white"> | 
 | 538 | <tr><td> | 
 | 539 |   <table width="100%" cellpadding="0" cellspacing="0" border="0"> | 
 | 540 |   <tr valign="top"><td> | 
 | 541 |   <h3 class="epydoc"><span class="sig"><span class="sig-name">to_json</span>(<span class="sig-arg">self</span>)</span> | 
 | 542 |   </h3> | 
 | 543 |   </td><td align="right" valign="top" | 
 | 544 |     ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaFileUpload.to_json">source code</a></span>  | 
 | 545 |     </td> | 
 | 546 |   </tr></table> | 
 | 547 |    | 
 | 548 |   <pre class="literalblock"> | 
| Joe Gregorio | ebd0b84 | 2012-06-15 14:14:17 -0400 | [diff] [blame] | 549 | Creating a JSON representation of an instance of MediaFileUpload. | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 550 |  | 
 | 551 | Returns: | 
 | 552 |    string, a JSON representation of this instance, suitable to pass to | 
 | 553 |    from_json(). | 
 | 554 |  | 
 | 555 | </pre> | 
 | 556 |   <dl class="fields"> | 
 | 557 |     <dt>Overrides: | 
 | 558 |         <a href="apiclient.http.MediaUpload-class.html#to_json">MediaUpload.to_json</a> | 
 | 559 |     </dt> | 
 | 560 |   </dl> | 
 | 561 | </td></tr></table> | 
 | 562 | </div> | 
 | 563 | <br /> | 
 | 564 | <!-- ==================== NAVIGATION BAR ==================== --> | 
 | 565 | <table class="navbar" border="0" width="100%" cellpadding="0" | 
 | 566 |        bgcolor="#a0c0ff" cellspacing="0"> | 
 | 567 |   <tr valign="middle"> | 
 | 568 |  | 
 | 569 |   <!-- Tree link --> | 
 | 570 |       <th>   <a | 
 | 571 |         href="module-tree.html">Trees</a>   </th> | 
 | 572 |  | 
 | 573 |   <!-- Index link --> | 
 | 574 |       <th>   <a | 
 | 575 |         href="identifier-index.html">Indices</a>   </th> | 
 | 576 |  | 
 | 577 |   <!-- Help link --> | 
 | 578 |       <th>   <a | 
 | 579 |         href="help.html">Help</a>   </th> | 
 | 580 |  | 
 | 581 |       <th class="navbar" width="100%"></th> | 
 | 582 |   </tr> | 
 | 583 | </table> | 
 | 584 | <table border="0" cellpadding="0" cellspacing="0" width="100%%"> | 
 | 585 |   <tr> | 
 | 586 |     <td align="left" class="footer"> | 
| Joe Gregorio | fa08c2e | 2012-07-23 16:52:03 -0400 | [diff] [blame^] | 587 |     Generated by Epydoc 3.0.1 on Mon Jul 23 15:49:58 2012 | 
| Joe Gregorio | 5dc0f5c | 2012-06-05 13:34:31 -0400 | [diff] [blame] | 588 |     </td> | 
 | 589 |     <td align="right" class="footer"> | 
 | 590 |       <a target="mainFrame" href="http://epydoc.sourceforge.net" | 
 | 591 |         >http://epydoc.sourceforge.net</a> | 
 | 592 |     </td> | 
 | 593 |   </tr> | 
 | 594 | </table> | 
 | 595 |  | 
 | 596 | <script type="text/javascript"> | 
 | 597 |   <!-- | 
 | 598 |   // Private objects are initially displayed (because if | 
 | 599 |   // javascript is turned off then we want them to be | 
 | 600 |   // visible); but by default, we want to hide them.  So hide | 
 | 601 |   // them unless we have a cookie that says to show them. | 
 | 602 |   checkCookie(); | 
 | 603 |   // --> | 
 | 604 | </script> | 
 | 605 | </body> | 
 | 606 | </html> |