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