Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 44454e4c65dda5a2a811553e1cc540140c039fd5 / . / docs / epy / apiclient.http.MediaUploadProgress-class.html
blob: 8c774eb0e293f1cdc3e031003a404322caf2f26f [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.MediaUploadProgress</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;MediaUploadProgress
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.MediaUploadProgress-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 MediaUploadProgress</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUploadProgress">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]58<center> <map id="uml_class_diagram_for_apiclien_21" name="uml_class_diagram_for_apiclien_21">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]59<area shape="rect" href="apiclient.http.MediaUploadProgress-class.html#__init__" title="Constructor." alt="" coords="17,36,287,55"/>
60<area shape="rect" href="apiclient.http.MediaUploadProgress-class.html#progress" title="Percent of upload completed, as a float." alt="" coords="17,55,287,73"/>
61<area shape="rect" href="apiclient.http.MediaUploadProgress-class.html" title="Status of a resumable upload." alt="" coords="16,11,288,75"/>
62</map>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]63 <img src="uml_class_diagram_for_apiclien_21.gif" alt='' usemap="#uml_class_diagram_for_apiclien_21" 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">
68Status of a resumable upload.
69
70</pre>
71
72<!-- ==================== INSTANCE METHODS ==================== -->
73<a name="section-InstanceMethods"></a>
74<table class="summary" border="1" cellpadding="3"
75 cellspacing="0" width="100%" bgcolor="white">
76<tr bgcolor="#70b0f0" class="table-header">
77 <td colspan="2" class="table-header">
78 <table border="0" cellpadding="0" cellspacing="0" width="100%">
79 <tr valign="top">
80 <td align="left"><span class="table-header">Instance Methods</span></td>
81 <td align="right" valign="top"
82 ><span class="options">[<a href="#section-InstanceMethods"
83 class="privatelink" onclick="toggle_private();"
84 >hide private</a>]</span></td>
85 </tr>
86 </table>
87 </td>
88</tr>
89<tr>
90 <td width="15%" align="right" valign="top" class="summary">
91 <span class="summary-type">&nbsp;</span>
92 </td><td class="summary">
93 <table width="100%" cellpadding="0" cellspacing="0" border="0">
94 <tr>
95 <td><span class="summary-sig"><a href="apiclient.http.MediaUploadProgress-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
96 <span class="summary-sig-arg">resumable_progress</span>,
97 <span class="summary-sig-arg">total_size</span>)</span><br />
98 Constructor.</td>
99 <td align="right" valign="top">
100 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUploadProgress.__init__">source&nbsp;code</a></span>
101
102 </td>
103 </tr>
104 </table>
105
106 </td>
107 </tr>
108<tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <table width="100%" cellpadding="0" cellspacing="0" border="0">
113 <tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]114 <td><span class="summary-sig"><a href="apiclient.http.MediaUploadProgress-class.html#progress" class="summary-sig-name">progress</a>(<span class="summary-sig-arg">self</span>)</span><br />
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]115 Percent of upload completed, as a float.</td>
116 <td align="right" valign="top">
117 <span class="codelink"><a href="apiclient.http-pysrc.html#MediaUploadProgress.progress">source&nbsp;code</a></span>
118
119 </td>
120 </tr>
121 </table>
122
123 </td>
124 </tr>
125 <tr>
126 <td colspan="2" class="summary">
127 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
128 <code>__delattr__</code>,
129 <code>__format__</code>,
130 <code>__getattribute__</code>,
131 <code>__hash__</code>,
132 <code>__new__</code>,
133 <code>__reduce__</code>,
134 <code>__reduce_ex__</code>,
135 <code>__repr__</code>,
136 <code>__setattr__</code>,
137 <code>__sizeof__</code>,
138 <code>__str__</code>,
139 <code>__subclasshook__</code>
140 </p>
141 </td>
142 </tr>
143</table>
144<!-- ==================== PROPERTIES ==================== -->
145<a name="section-Properties"></a>
146<table class="summary" border="1" cellpadding="3"
147 cellspacing="0" width="100%" bgcolor="white">
148<tr bgcolor="#70b0f0" class="table-header">
149 <td colspan="2" class="table-header">
150 <table border="0" cellpadding="0" cellspacing="0" width="100%">
151 <tr valign="top">
152 <td align="left"><span class="table-header">Properties</span></td>
153 <td align="right" valign="top"
154 ><span class="options">[<a href="#section-Properties"
155 class="privatelink" onclick="toggle_private();"
156 >hide private</a>]</span></td>
157 </tr>
158 </table>
159 </td>
160</tr>
161 <tr>
162 <td colspan="2" class="summary">
163 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
164 <code>__class__</code>
165 </p>
166 </td>
167 </tr>
168</table>
169<!-- ==================== METHOD DETAILS ==================== -->
170<a name="section-MethodDetails"></a>
171<table class="details" border="1" cellpadding="3"
172 cellspacing="0" width="100%" bgcolor="white">
173<tr bgcolor="#70b0f0" class="table-header">
174 <td colspan="2" class="table-header">
175 <table border="0" cellpadding="0" cellspacing="0" width="100%">
176 <tr valign="top">
177 <td align="left"><span class="table-header">Method Details</span></td>
178 <td align="right" valign="top"
179 ><span class="options">[<a href="#section-MethodDetails"
180 class="privatelink" onclick="toggle_private();"
181 >hide private</a>]</span></td>
182 </tr>
183 </table>
184 </td>
185</tr>
186</table>
187<a name="__init__"></a>
188<div>
189<table class="details" border="1" cellpadding="3"
190 cellspacing="0" width="100%" bgcolor="white">
191<tr><td>
192 <table width="100%" cellpadding="0" cellspacing="0" border="0">
193 <tr valign="top"><td>
194 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
195 <span class="sig-arg">resumable_progress</span>,
196 <span class="sig-arg">total_size</span>)</span>
197 <br /><em class="fname">(Constructor)</em>
198 </h3>
199 </td><td align="right" valign="top"
200 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUploadProgress.__init__">source&nbsp;code</a></span>&nbsp;
201 </td>
202 </tr></table>
203
204 <pre class="literalblock">
205Constructor.
206
207Args:
208 resumable_progress: int, bytes sent so far.
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]209 total_size: int, total bytes in complete upload, or None if the total
210 upload size isn't known ahead of time.
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]211
212</pre>
213 <dl class="fields">
214 <dt>Overrides:
215 object.__init__
216 </dt>
217 </dl>
218</td></tr></table>
219</div>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]220<a name="progress"></a>
221<div>
222<table class="details" border="1" cellpadding="3"
223 cellspacing="0" width="100%" bgcolor="white">
224<tr><td>
225 <table width="100%" cellpadding="0" cellspacing="0" border="0">
226 <tr valign="top"><td>
227 <h3 class="epydoc"><span class="sig"><span class="sig-name">progress</span>(<span class="sig-arg">self</span>)</span>
228 </h3>
229 </td><td align="right" valign="top"
230 ><span class="codelink"><a href="apiclient.http-pysrc.html#MediaUploadProgress.progress">source&nbsp;code</a></span>&nbsp;
231 </td>
232 </tr></table>
233
234 <pre class="literalblock">
235Percent of upload completed, as a float.
236
237Returns:
238 the percentage complete as a float, returning 0.0 if the total size of
239 the upload is unknown.
240
241</pre>
242 <dl class="fields">
243 </dl>
244</td></tr></table>
245</div>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]246<br />
247<!-- ==================== NAVIGATION BAR ==================== -->
248<table class="navbar" border="0" width="100%" cellpadding="0"
249 bgcolor="#a0c0ff" cellspacing="0">
250 <tr valign="middle">
251
252 <!-- Tree link -->
253 <th>&nbsp;&nbsp;&nbsp;<a
254 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
255
256 <!-- Index link -->
257 <th>&nbsp;&nbsp;&nbsp;<a
258 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
259
260 <!-- Help link -->
261 <th>&nbsp;&nbsp;&nbsp;<a
262 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
263
264 <th class="navbar" width="100%"></th>
265 </tr>
266</table>
267<table border="0" cellpadding="0" cellspacing="0" width="100%%">
268 <tr>
269 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]270 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]271 </td>
272 <td align="right" class="footer">
273 <a target="mainFrame" href="http://epydoc.sourceforge.net"
274 >http://epydoc.sourceforge.net</a>
275 </td>
276 </tr>
277</table>
278
279<script type="text/javascript">
280 <!--
281 // Private objects are initially displayed (because if
282 // javascript is turned off then we want them to be
283 // visible); but by default, we want to hide them. So hide
284 // them unless we have a cookie that says to show them.
285 checkCookie();
286 // -->
287</script>
288</body>
289</html>