Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f4839b0d74d8678a8e08964ce3e5899a77d8375f / . / docs / epy / apiclient.http.MediaInMemoryUpload-class.html
blob: 37d05e079755aaa03baf563fe6dccbb834c118d7 [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.MediaInMemoryUpload</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;MediaInMemoryUpload
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.MediaInMemoryUpload-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 MediaInMemoryUpload</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload">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_mediainmem" name="class_hierarchy_for_mediainmem">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]59<area shape="rect" href="apiclient.http.MediaInMemoryUpload-class.html" title="MediaInMemoryUpload" alt="" coords="5,5,157,32"/>
60<area shape="rect" href="apiclient.http.MediaIoBaseUpload-class.html" title="MediaIoBaseUpload" alt="" coords="181,5,317,32"/>
61<area shape="rect" href="apiclient.http.MediaUpload-class.html" title="MediaUpload" alt="" coords="341,5,437,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_mediainmem.gif" alt='' usemap="#class_hierarchy_for_mediainmem" 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">
68MediaUpload for a chunk of bytes.
69
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]70DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for
71the stream.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]72
73</pre>
74
75<!-- ==================== INSTANCE METHODS ==================== -->
76<a name="section-InstanceMethods"></a>
77<table class="summary" border="1" cellpadding="3"
78 cellspacing="0" width="100%" bgcolor="white">
79<tr bgcolor="#70b0f0" class="table-header">
80 <td colspan="2" class="table-header">
81 <table border="0" cellpadding="0" cellspacing="0" width="100%">
82 <tr valign="top">
83 <td align="left"><span class="table-header">Instance Methods</span></td>
84 <td align="right" valign="top"
85 ><span class="options">[<a href="#section-InstanceMethods"
86 class="privatelink" onclick="toggle_private();"
87 >hide private</a>]</span></td>
88 </tr>
89 </table>
90 </td>
91</tr>
92<tr>
93 <td width="15%" align="right" valign="top" class="summary">
94 <span class="summary-type">&nbsp;</span>
95 </td><td class="summary">
96 <table width="100%" cellpadding="0" cellspacing="0" border="0">
97 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]98 <td><span class="summary-sig"><a href="apiclient.http.MediaInMemoryUpload-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
99 <span class="summary-sig-arg">body</span>,
100 <span class="summary-sig-arg">mimetype</span>=<span class="summary-sig-default">'application/octet-stream'</span>,
101 <span class="summary-sig-arg">chunksize</span>=<span class="summary-sig-default">DEFAULT_CHUNK_SIZE</span>,
102 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">False</span>)</span><br />
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]103 Create a new MediaInMemoryUpload.</td>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]104 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]105 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.__init__">source&nbsp;code</a></span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]106
107 </td>
108 </tr>
109 </table>
110
111 </td>
112 </tr>
113 <tr>
114 <td colspan="2" class="summary">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]115 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaIoBaseUpload-class.html">MediaIoBaseUpload</a></code></b>:
116 <code><a href="apiclient.http.MediaIoBaseUpload-class.html#chunksize">chunksize</a></code>,
117 <code><a href="apiclient.http.MediaIoBaseUpload-class.html#getbytes">getbytes</a></code>,
118 <code><a href="apiclient.http.MediaIoBaseUpload-class.html#has_stream">has_stream</a></code>,
119 <code><a href="apiclient.http.MediaIoBaseUpload-class.html#mimetype">mimetype</a></code>,
120 <code><a href="apiclient.http.MediaIoBaseUpload-class.html#resumable">resumable</a></code>,
121 <code><a href="apiclient.http.MediaIoBaseUpload-class.html#size">size</a></code>,
122 <code><a href="apiclient.http.MediaIoBaseUpload-class.html#stream">stream</a></code>,
123 <code><a href="apiclient.http.MediaIoBaseUpload-class.html#to_json">to_json</a></code>
124 </p>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]125 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b> (private):
126 <code><a href="apiclient.http.MediaUpload-class.html#_to_json" onclick="show_private();">_to_json</a></code>
127 </p></div>
128 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
129 <code>__delattr__</code>,
130 <code>__format__</code>,
131 <code>__getattribute__</code>,
132 <code>__hash__</code>,
133 <code>__new__</code>,
134 <code>__reduce__</code>,
135 <code>__reduce_ex__</code>,
136 <code>__repr__</code>,
137 <code>__setattr__</code>,
138 <code>__sizeof__</code>,
139 <code>__str__</code>,
140 <code>__subclasshook__</code>
141 </p>
142 </td>
143 </tr>
144</table>
145<!-- ==================== CLASS METHODS ==================== -->
146<a name="section-ClassMethods"></a>
147<table class="summary" border="1" cellpadding="3"
148 cellspacing="0" width="100%" bgcolor="white">
149<tr bgcolor="#70b0f0" class="table-header">
150 <td colspan="2" class="table-header">
151 <table border="0" cellpadding="0" cellspacing="0" width="100%">
152 <tr valign="top">
153 <td align="left"><span class="table-header">Class Methods</span></td>
154 <td align="right" valign="top"
155 ><span class="options">[<a href="#section-ClassMethods"
156 class="privatelink" onclick="toggle_private();"
157 >hide private</a>]</span></td>
158 </tr>
159 </table>
160 </td>
161</tr>
162 <tr>
163 <td colspan="2" class="summary">
164 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.http.MediaUpload-class.html">MediaUpload</a></code></b>:
165 <code><a href="apiclient.http.MediaUpload-class.html#new_from_json">new_from_json</a></code>
166 </p>
167 </td>
168 </tr>
169</table>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]170<!-- ==================== PROPERTIES ==================== -->
171<a name="section-Properties"></a>
172<table class="summary" border="1" cellpadding="3"
173 cellspacing="0" width="100%" bgcolor="white">
174<tr bgcolor="#70b0f0" class="table-header">
175 <td colspan="2" class="table-header">
176 <table border="0" cellpadding="0" cellspacing="0" width="100%">
177 <tr valign="top">
178 <td align="left"><span class="table-header">Properties</span></td>
179 <td align="right" valign="top"
180 ><span class="options">[<a href="#section-Properties"
181 class="privatelink" onclick="toggle_private();"
182 >hide private</a>]</span></td>
183 </tr>
184 </table>
185 </td>
186</tr>
187 <tr>
188 <td colspan="2" class="summary">
189 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
190 <code>__class__</code>
191 </p>
192 </td>
193 </tr>
194</table>
195<!-- ==================== METHOD DETAILS ==================== -->
196<a name="section-MethodDetails"></a>
197<table class="details" border="1" cellpadding="3"
198 cellspacing="0" width="100%" bgcolor="white">
199<tr bgcolor="#70b0f0" class="table-header">
200 <td colspan="2" class="table-header">
201 <table border="0" cellpadding="0" cellspacing="0" width="100%">
202 <tr valign="top">
203 <td align="left"><span class="table-header">Method Details</span></td>
204 <td align="right" valign="top"
205 ><span class="options">[<a href="#section-MethodDetails"
206 class="privatelink" onclick="toggle_private();"
207 >hide private</a>]</span></td>
208 </tr>
209 </table>
210 </td>
211</tr>
212</table>
213<a name="__init__"></a>
214<div>
215<table class="details" border="1" cellpadding="3"
216 cellspacing="0" width="100%" bgcolor="white">
217<tr><td>
218 <table width="100%" cellpadding="0" cellspacing="0" border="0">
219 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]220 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
221 <span class="sig-arg">body</span>,
222 <span class="sig-arg">mimetype</span>=<span class="sig-default">'application/octet-stream'</span>,
223 <span class="sig-arg">chunksize</span>=<span class="sig-default">DEFAULT_CHUNK_SIZE</span>,
224 <span class="sig-arg">resumable</span>=<span class="sig-default">False</span>)</span>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]225 <br /><em class="fname">(Constructor)</em>
226 </h3>
227 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]228 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaInMemoryUpload.__init__">source&nbsp;code</a></span>&nbsp;
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]229 </td>
230 </tr></table>
231
232 <pre class="literalblock">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]233Create a new MediaInMemoryUpload.
234
235DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for
236the stream.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]237
238Args:
239 body: string, Bytes of body content.
240 mimetype: string, Mime-type of the file or default of
241 'application/octet-stream'.
242 chunksize: int, File will be uploaded in chunks of this many bytes. Only
243 used if resumable=True.
244 resumable: bool, True if this is a resumable upload. False means upload
245 in a single request.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]246
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]247
248</pre>
249 <dl class="fields">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]250 <dt>Decorators:</dt>
251 <dd><ul class="nomargin-top">
252 <li><code>@util.positional(2)</code></li>
253 </ul></dd>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]254 <dt>Overrides:
255 object.__init__
256 </dt>
257 </dl>
258</td></tr></table>
259</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]260<br />
261<!-- ==================== NAVIGATION BAR ==================== -->
262<table class="navbar" border="0" width="100%" cellpadding="0"
263 bgcolor="#a0c0ff" cellspacing="0">
264 <tr valign="middle">
265
266 <!-- Tree link -->
267 <th>&nbsp;&nbsp;&nbsp;<a
268 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
269
270 <!-- Index link -->
271 <th>&nbsp;&nbsp;&nbsp;<a
272 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
273
274 <!-- Help link -->
275 <th>&nbsp;&nbsp;&nbsp;<a
276 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
277
278 <th class="navbar" width="100%"></th>
279 </tr>
280</table>
281<table border="0" cellpadding="0" cellspacing="0" width="100%%">
282 <tr>
283 <td align="left" class="footer">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame^]284 Generated by Epydoc 3.0.1 on Thu Sep 6 13:36:12 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]285 </td>
286 <td align="right" class="footer">
287 <a target="mainFrame" href="http://epydoc.sourceforge.net"
288 >http://epydoc.sourceforge.net</a>
289 </td>
290 </tr>
291</table>
292
293<script type="text/javascript">
294 <!--
295 // Private objects are initially displayed (because if
296 // javascript is turned off then we want them to be
297 // visible); but by default, we want to hide them. So hide
298 // them unless we have a cookie that says to show them.
299 checkCookie();
300 // -->
301</script>
302</body>
303</html>