blob: 0aff590f61540f9ea5c00fd43f7796babf742dbd [file] [log] [blame]
Joe Gregorio30dfdc32010-12-09 16:34:22 -05001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module apiclient.http</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.http</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregorio66212032012-06-14 09:10:14 -040011><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/http.py">/home/jcgregorio/projects/clean/apiclient/http.py</a></font></td></tr></table>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050012 <p><tt>Classes&nbsp;to&nbsp;encapsulate&nbsp;a&nbsp;single&nbsp;HTTP&nbsp;request.<br>
13&nbsp;<br>
14The&nbsp;classes&nbsp;implement&nbsp;a&nbsp;command&nbsp;pattern,&nbsp;with&nbsp;every<br>
15<a href="__builtin__.html#object">object</a>&nbsp;supporting&nbsp;an&nbsp;execute()&nbsp;method&nbsp;that&nbsp;does&nbsp;the<br>
16actuall&nbsp;HTTP&nbsp;request.</tt></p>
17<p>
18<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio6e537032011-02-09 23:04:26 -050019<tr bgcolor="#aa55cc">
20<td colspan=3 valign=bottom>&nbsp;<br>
21<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
22
23<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregoriob417caf2011-12-08 12:04:24 -050024<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="StringIO.html">StringIO</a><br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050025<a href="base64.html">base64</a><br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050026<a href="copy.html">copy</a><br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050027</td><td width="25%" valign=top><a href="gzip.html">gzip</a><br>
28<a href="httplib2.html">httplib2</a><br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050029<a href="apiclient.mimeparse.html">apiclient.mimeparse</a><br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050030</td><td width="25%" valign=top><a href="mimetypes.html">mimetypes</a><br>
31<a href="os.html">os</a><br>
32<a href="json.html">json</a><br>
33</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
34<a href="urlparse.html">urlparse</a><br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050035<a href="uuid.html">uuid</a><br>
36</td></tr></table></td></tr></table><p>
Joe Gregorio6e537032011-02-09 23:04:26 -050037<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio30dfdc32010-12-09 16:34:22 -050038<tr bgcolor="#ee77aa">
39<td colspan=3 valign=bottom>&nbsp;<br>
40<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
41
42<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
43<td width="100%"><dl>
44<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
45</font></dt><dd>
46<dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -040047<dt><font face="helvetica, arial"><a href="apiclient.http.html#BatchHttpRequest">BatchHttpRequest</a>
48</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#HttpMock">HttpMock</a>
49</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#HttpMockSequence">HttpMockSequence</a>
50</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#HttpRequest">HttpRequest</a>
51</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#HttpRequestMock">HttpRequestMock</a>
52</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaUpload">MediaUpload</a>
53</font></dt><dd>
54<dl>
55<dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaFileUpload">MediaFileUpload</a>
56</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaInMemoryUpload">MediaInMemoryUpload</a>
Joe Gregorio66212032012-06-14 09:10:14 -040057</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaIoBaseUpload">MediaIoBaseUpload</a>
Joe Gregoriod9d00902012-04-13 07:58:30 -040058</font></dt></dl>
59</dd>
60<dt><font face="helvetica, arial"><a href="apiclient.http.html#MediaUploadProgress">MediaUploadProgress</a>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050061</font></dt><dt><font face="helvetica, arial"><a href="apiclient.http.html#RequestMockBuilder">RequestMockBuilder</a>
62</font></dt></dl>
63</dd>
64</dl>
65 <p>
66<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
67<tr bgcolor="#ffc8d8">
68<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -040069<font color="#000000" face="helvetica, arial"><a name="BatchHttpRequest">class <strong>BatchHttpRequest</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
70
71<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
72<td colspan=2><tt>Batches&nbsp;multiple&nbsp;<a href="#HttpRequest">HttpRequest</a>&nbsp;objects&nbsp;into&nbsp;a&nbsp;single&nbsp;HTTP&nbsp;request.<br>&nbsp;</tt></td></tr>
73<tr><td>&nbsp;</td>
74<td width="100%">Methods defined here:<br>
75<dl><dt><a name="BatchHttpRequest-__init__"><strong>__init__</strong></a>(self, callback<font color="#909090">=None</font>, batch_uri<font color="#909090">=None</font>)</dt><dd><tt>Constructor&nbsp;for&nbsp;a&nbsp;<a href="#BatchHttpRequest">BatchHttpRequest</a>.<br>
76&nbsp;<br>
77Args:<br>
78&nbsp;&nbsp;callback:&nbsp;callable,&nbsp;A&nbsp;callback&nbsp;to&nbsp;be&nbsp;called&nbsp;for&nbsp;each&nbsp;response,&nbsp;of&nbsp;the<br>
79&nbsp;&nbsp;&nbsp;&nbsp;form&nbsp;callback(id,&nbsp;response).&nbsp;The&nbsp;first&nbsp;parameter&nbsp;is&nbsp;the&nbsp;request&nbsp;id,&nbsp;and<br>
80&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;second&nbsp;is&nbsp;the&nbsp;deserialized&nbsp;response&nbsp;<a href="__builtin__.html#object">object</a>.<br>
81&nbsp;&nbsp;batch_uri:&nbsp;string,&nbsp;URI&nbsp;to&nbsp;send&nbsp;batch&nbsp;requests&nbsp;to.</tt></dd></dl>
82
83<dl><dt><a name="BatchHttpRequest-add"><strong>add</strong></a>(self, request, callback<font color="#909090">=None</font>, request_id<font color="#909090">=None</font>)</dt><dd><tt>Add&nbsp;a&nbsp;new&nbsp;request.<br>
84&nbsp;<br>
85Every&nbsp;callback&nbsp;added&nbsp;will&nbsp;be&nbsp;paired&nbsp;with&nbsp;a&nbsp;unique&nbsp;id,&nbsp;the&nbsp;request_id.&nbsp;That<br>
86unique&nbsp;id&nbsp;will&nbsp;be&nbsp;passed&nbsp;back&nbsp;to&nbsp;the&nbsp;callback&nbsp;when&nbsp;the&nbsp;response&nbsp;comes&nbsp;back<br>
87from&nbsp;the&nbsp;server.&nbsp;The&nbsp;default&nbsp;behavior&nbsp;is&nbsp;to&nbsp;have&nbsp;the&nbsp;library&nbsp;generate&nbsp;it's<br>
88own&nbsp;unique&nbsp;id.&nbsp;If&nbsp;the&nbsp;caller&nbsp;passes&nbsp;in&nbsp;a&nbsp;request_id&nbsp;then&nbsp;they&nbsp;must&nbsp;ensure<br>
89uniqueness&nbsp;for&nbsp;each&nbsp;request_id,&nbsp;and&nbsp;if&nbsp;they&nbsp;are&nbsp;not&nbsp;an&nbsp;exception&nbsp;is<br>
90raised.&nbsp;Callers&nbsp;should&nbsp;either&nbsp;supply&nbsp;all&nbsp;request_ids&nbsp;or&nbsp;nevery&nbsp;supply&nbsp;a<br>
91request&nbsp;id,&nbsp;to&nbsp;avoid&nbsp;such&nbsp;an&nbsp;error.<br>
92&nbsp;<br>
93Args:<br>
94&nbsp;&nbsp;request:&nbsp;<a href="#HttpRequest">HttpRequest</a>,&nbsp;Request&nbsp;to&nbsp;add&nbsp;to&nbsp;the&nbsp;batch.<br>
95&nbsp;&nbsp;callback:&nbsp;callable,&nbsp;A&nbsp;callback&nbsp;to&nbsp;be&nbsp;called&nbsp;for&nbsp;this&nbsp;response,&nbsp;of&nbsp;the<br>
96&nbsp;&nbsp;&nbsp;&nbsp;form&nbsp;callback(id,&nbsp;response).&nbsp;The&nbsp;first&nbsp;parameter&nbsp;is&nbsp;the&nbsp;request&nbsp;id,&nbsp;and<br>
97&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;second&nbsp;is&nbsp;the&nbsp;deserialized&nbsp;response&nbsp;<a href="__builtin__.html#object">object</a>.<br>
98&nbsp;&nbsp;request_id:&nbsp;string,&nbsp;A&nbsp;unique&nbsp;id&nbsp;for&nbsp;the&nbsp;request.&nbsp;The&nbsp;id&nbsp;will&nbsp;be&nbsp;passed&nbsp;to<br>
99&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;callback&nbsp;with&nbsp;the&nbsp;response.<br>
100&nbsp;<br>
101Returns:<br>
102&nbsp;&nbsp;None<br>
103&nbsp;<br>
104Raises:<br>
105&nbsp;&nbsp;BatchError&nbsp;if&nbsp;a&nbsp;resumable&nbsp;request&nbsp;is&nbsp;added&nbsp;to&nbsp;a&nbsp;batch.<br>
106&nbsp;&nbsp;KeyError&nbsp;is&nbsp;the&nbsp;request_id&nbsp;is&nbsp;not&nbsp;unique.</tt></dd></dl>
107
108<dl><dt><a name="BatchHttpRequest-execute"><strong>execute</strong></a>(self, http<font color="#909090">=None</font>)</dt><dd><tt>Execute&nbsp;all&nbsp;the&nbsp;requests&nbsp;as&nbsp;a&nbsp;single&nbsp;batched&nbsp;HTTP&nbsp;request.<br>
109&nbsp;<br>
110Args:<br>
111&nbsp;&nbsp;http:&nbsp;httplib2.Http,&nbsp;an&nbsp;http&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;to&nbsp;be&nbsp;used&nbsp;in&nbsp;place&nbsp;of&nbsp;the&nbsp;one&nbsp;the<br>
112&nbsp;&nbsp;&nbsp;&nbsp;<a href="#HttpRequest">HttpRequest</a>&nbsp;request&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;was&nbsp;constructed&nbsp;with.&nbsp;&nbsp;If&nbsp;one&nbsp;isn't&nbsp;supplied<br>
113&nbsp;&nbsp;&nbsp;&nbsp;then&nbsp;use&nbsp;a&nbsp;http&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;from&nbsp;the&nbsp;requests&nbsp;in&nbsp;this&nbsp;batch.<br>
114&nbsp;<br>
115Returns:<br>
116&nbsp;&nbsp;None<br>
117&nbsp;<br>
118Raises:<br>
119&nbsp;&nbsp;httplib2.Error&nbsp;if&nbsp;a&nbsp;transport&nbsp;error&nbsp;has&nbsp;occured.<br>
120&nbsp;&nbsp;apiclient.errors.BatchError&nbsp;if&nbsp;the&nbsp;response&nbsp;is&nbsp;the&nbsp;wrong&nbsp;format.</tt></dd></dl>
121
122<hr>
123Data descriptors defined here:<br>
124<dl><dt><strong>__dict__</strong></dt>
125<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
126</dl>
127<dl><dt><strong>__weakref__</strong></dt>
128<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
129</dl>
130</td></tr></table> <p>
131<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
132<tr bgcolor="#ffc8d8">
133<td colspan=3 valign=bottom>&nbsp;<br>
134<font color="#000000" face="helvetica, arial"><a name="HttpMock">class <strong>HttpMock</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
135
136<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
137<td colspan=2><tt>Mock&nbsp;of&nbsp;httplib2.Http<br>&nbsp;</tt></td></tr>
138<tr><td>&nbsp;</td>
139<td width="100%">Methods defined here:<br>
140<dl><dt><a name="HttpMock-__init__"><strong>__init__</strong></a>(self, filename, headers<font color="#909090">=None</font>)</dt><dd><tt>Args:<br>
141&nbsp;&nbsp;filename:&nbsp;string,&nbsp;absolute&nbsp;filename&nbsp;to&nbsp;read&nbsp;response&nbsp;from<br>
142&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;header&nbsp;to&nbsp;return&nbsp;with&nbsp;response</tt></dd></dl>
143
144<dl><dt><a name="HttpMock-request"><strong>request</strong></a>(self, uri, method<font color="#909090">='GET'</font>, body<font color="#909090">=None</font>, headers<font color="#909090">=None</font>, redirections<font color="#909090">=1</font>, connection_type<font color="#909090">=None</font>)</dt></dl>
145
146<hr>
147Data descriptors defined here:<br>
148<dl><dt><strong>__dict__</strong></dt>
149<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
150</dl>
151<dl><dt><strong>__weakref__</strong></dt>
152<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
153</dl>
154</td></tr></table> <p>
155<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
156<tr bgcolor="#ffc8d8">
157<td colspan=3 valign=bottom>&nbsp;<br>
158<font color="#000000" face="helvetica, arial"><a name="HttpMockSequence">class <strong>HttpMockSequence</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
159
160<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
161<td colspan=2><tt>Mock&nbsp;of&nbsp;httplib2.Http<br>
162&nbsp;<br>
163Mocks&nbsp;a&nbsp;sequence&nbsp;of&nbsp;calls&nbsp;to&nbsp;request&nbsp;returning&nbsp;different&nbsp;responses&nbsp;for&nbsp;each<br>
164call.&nbsp;Create&nbsp;an&nbsp;instance&nbsp;initialized&nbsp;with&nbsp;the&nbsp;desired&nbsp;response&nbsp;headers<br>
165and&nbsp;content&nbsp;and&nbsp;then&nbsp;use&nbsp;as&nbsp;if&nbsp;an&nbsp;httplib2.Http&nbsp;instance.<br>
166&nbsp;<br>
167&nbsp;&nbsp;http&nbsp;=&nbsp;<a href="#HttpMockSequence">HttpMockSequence</a>([<br>
168&nbsp;&nbsp;&nbsp;&nbsp;({'status':&nbsp;'401'},&nbsp;''),<br>
169&nbsp;&nbsp;&nbsp;&nbsp;({'status':&nbsp;'200'},&nbsp;'{"access_token":"1/3w","expires_in":3600}'),<br>
170&nbsp;&nbsp;&nbsp;&nbsp;({'status':&nbsp;'200'},&nbsp;'echo_request_headers'),<br>
171&nbsp;&nbsp;&nbsp;&nbsp;])<br>
172&nbsp;&nbsp;resp,&nbsp;content&nbsp;=&nbsp;http.<a href="#HttpMockSequence-request">request</a>("<a href="http://examples.com">http://examples.com</a>")<br>
173&nbsp;<br>
174There&nbsp;are&nbsp;special&nbsp;values&nbsp;you&nbsp;can&nbsp;pass&nbsp;in&nbsp;for&nbsp;content&nbsp;to&nbsp;trigger<br>
175behavours&nbsp;that&nbsp;are&nbsp;helpful&nbsp;in&nbsp;testing.<br>
176&nbsp;<br>
177'echo_request_headers'&nbsp;means&nbsp;return&nbsp;the&nbsp;request&nbsp;headers&nbsp;in&nbsp;the&nbsp;response&nbsp;body<br>
178'echo_request_headers_as_json'&nbsp;means&nbsp;return&nbsp;the&nbsp;request&nbsp;headers&nbsp;in<br>
179&nbsp;&nbsp;&nbsp;the&nbsp;response&nbsp;body<br>
180'echo_request_body'&nbsp;means&nbsp;return&nbsp;the&nbsp;request&nbsp;body&nbsp;in&nbsp;the&nbsp;response&nbsp;body<br>
181'echo_request_uri'&nbsp;means&nbsp;return&nbsp;the&nbsp;request&nbsp;uri&nbsp;in&nbsp;the&nbsp;response&nbsp;body<br>&nbsp;</tt></td></tr>
182<tr><td>&nbsp;</td>
183<td width="100%">Methods defined here:<br>
184<dl><dt><a name="HttpMockSequence-__init__"><strong>__init__</strong></a>(self, iterable)</dt><dd><tt>Args:<br>
185&nbsp;&nbsp;iterable:&nbsp;iterable,&nbsp;a&nbsp;sequence&nbsp;of&nbsp;pairs&nbsp;of&nbsp;(headers,&nbsp;body)</tt></dd></dl>
186
187<dl><dt><a name="HttpMockSequence-request"><strong>request</strong></a>(self, uri, method<font color="#909090">='GET'</font>, body<font color="#909090">=None</font>, headers<font color="#909090">=None</font>, redirections<font color="#909090">=1</font>, connection_type<font color="#909090">=None</font>)</dt></dl>
188
189<hr>
190Data descriptors defined here:<br>
191<dl><dt><strong>__dict__</strong></dt>
192<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
193</dl>
194<dl><dt><strong>__weakref__</strong></dt>
195<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
196</dl>
197</td></tr></table> <p>
198<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
199<tr bgcolor="#ffc8d8">
200<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500201<font color="#000000" face="helvetica, arial"><a name="HttpRequest">class <strong>HttpRequest</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
202
203<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
204<td colspan=2><tt>Encapsulates&nbsp;a&nbsp;single&nbsp;HTTP&nbsp;request.<br>&nbsp;</tt></td></tr>
205<tr><td>&nbsp;</td>
206<td width="100%">Methods defined here:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500207<dl><dt><a name="HttpRequest-__init__"><strong>__init__</strong></a>(self, http, postproc, uri, method<font color="#909090">='GET'</font>, body<font color="#909090">=None</font>, headers<font color="#909090">=None</font>, methodId<font color="#909090">=None</font>, resumable<font color="#909090">=None</font>)</dt><dd><tt>Constructor&nbsp;for&nbsp;an&nbsp;<a href="#HttpRequest">HttpRequest</a>.<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500208&nbsp;<br>
209Args:<br>
210&nbsp;&nbsp;http:&nbsp;httplib2.Http,&nbsp;the&nbsp;transport&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;to&nbsp;use&nbsp;to&nbsp;make&nbsp;a&nbsp;request<br>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500211&nbsp;&nbsp;postproc:&nbsp;callable,&nbsp;called&nbsp;on&nbsp;the&nbsp;HTTP&nbsp;response&nbsp;and&nbsp;content&nbsp;to&nbsp;transform<br>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;it&nbsp;into&nbsp;a&nbsp;data&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;before&nbsp;returning,&nbsp;or&nbsp;raising&nbsp;an&nbsp;exception<br>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;on&nbsp;an&nbsp;error.<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500214&nbsp;&nbsp;uri:&nbsp;string,&nbsp;the&nbsp;absolute&nbsp;URI&nbsp;to&nbsp;send&nbsp;the&nbsp;request&nbsp;to<br>
215&nbsp;&nbsp;method:&nbsp;string,&nbsp;the&nbsp;HTTP&nbsp;method&nbsp;to&nbsp;use<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500216&nbsp;&nbsp;body:&nbsp;string,&nbsp;the&nbsp;request&nbsp;body&nbsp;of&nbsp;the&nbsp;HTTP&nbsp;request,<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500217&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;the&nbsp;HTTP&nbsp;request&nbsp;headers<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500218&nbsp;&nbsp;methodId:&nbsp;string,&nbsp;a&nbsp;unique&nbsp;identifier&nbsp;for&nbsp;the&nbsp;API&nbsp;method&nbsp;being&nbsp;called.<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400219&nbsp;&nbsp;resumable:&nbsp;<a href="#MediaUpload">MediaUpload</a>,&nbsp;None&nbsp;if&nbsp;this&nbsp;is&nbsp;not&nbsp;a&nbsp;resumbale&nbsp;request.</tt></dd></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500220
221<dl><dt><a name="HttpRequest-execute"><strong>execute</strong></a>(self, http<font color="#909090">=None</font>)</dt><dd><tt>Execute&nbsp;the&nbsp;request.<br>
222&nbsp;<br>
223Args:<br>
224&nbsp;&nbsp;http:&nbsp;httplib2.Http,&nbsp;an&nbsp;http&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;to&nbsp;be&nbsp;used&nbsp;in&nbsp;place&nbsp;of&nbsp;the<br>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;one&nbsp;the&nbsp;<a href="#HttpRequest">HttpRequest</a>&nbsp;request&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;was&nbsp;constructed&nbsp;with.<br>
226&nbsp;<br>
227Returns:<br>
228&nbsp;&nbsp;A&nbsp;deserialized&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;model&nbsp;of&nbsp;the&nbsp;response&nbsp;body&nbsp;as&nbsp;determined<br>
229&nbsp;&nbsp;by&nbsp;the&nbsp;postproc.<br>
230&nbsp;<br>
231Raises:<br>
232&nbsp;&nbsp;apiclient.errors.HttpError&nbsp;if&nbsp;the&nbsp;response&nbsp;was&nbsp;not&nbsp;a&nbsp;2xx.<br>
233&nbsp;&nbsp;httplib2.Error&nbsp;if&nbsp;a&nbsp;transport&nbsp;error&nbsp;has&nbsp;occured.</tt></dd></dl>
234
Joe Gregoriob417caf2011-12-08 12:04:24 -0500235<dl><dt><a name="HttpRequest-next_chunk"><strong>next_chunk</strong></a>(self, http<font color="#909090">=None</font>)</dt><dd><tt>Execute&nbsp;the&nbsp;next&nbsp;step&nbsp;of&nbsp;a&nbsp;resumable&nbsp;upload.<br>
236&nbsp;<br>
237Can&nbsp;only&nbsp;be&nbsp;used&nbsp;if&nbsp;the&nbsp;method&nbsp;being&nbsp;executed&nbsp;supports&nbsp;media&nbsp;uploads&nbsp;and<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400238the&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;passed&nbsp;in&nbsp;was&nbsp;flagged&nbsp;as&nbsp;using&nbsp;resumable&nbsp;upload.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500239&nbsp;<br>
240Example:<br>
241&nbsp;<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400242&nbsp;&nbsp;media&nbsp;=&nbsp;<a href="#MediaFileUpload">MediaFileUpload</a>('smiley.png',&nbsp;mimetype='image/png',<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500243&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;chunksize=1000,&nbsp;resumable=True)<br>
244&nbsp;&nbsp;request&nbsp;=&nbsp;service.objects().insert(<br>
245&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;bucket=buckets['items'][0]['id'],<br>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name='smiley.png',<br>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;media_body=media)<br>
248&nbsp;<br>
249&nbsp;&nbsp;response&nbsp;=&nbsp;None<br>
250&nbsp;&nbsp;while&nbsp;response&nbsp;is&nbsp;None:<br>
251&nbsp;&nbsp;&nbsp;&nbsp;status,&nbsp;response&nbsp;=&nbsp;request.<a href="#HttpRequest-next_chunk">next_chunk</a>()<br>
252&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;status:<br>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;print&nbsp;"Upload&nbsp;%d%%&nbsp;complete."&nbsp;%&nbsp;int(status.progress()&nbsp;*&nbsp;100)<br>
254&nbsp;<br>
255&nbsp;<br>
256Returns:<br>
257&nbsp;&nbsp;(status,&nbsp;body):&nbsp;(ResumableMediaStatus,&nbsp;<a href="__builtin__.html#object">object</a>)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;body&nbsp;will&nbsp;be&nbsp;None&nbsp;until&nbsp;the&nbsp;resumable&nbsp;media&nbsp;is&nbsp;fully&nbsp;uploaded.<br>
259&nbsp;<br>
260Raises:<br>
261&nbsp;&nbsp;apiclient.errors.HttpError&nbsp;if&nbsp;the&nbsp;response&nbsp;was&nbsp;not&nbsp;a&nbsp;2xx.<br>
262&nbsp;&nbsp;httplib2.Error&nbsp;if&nbsp;a&nbsp;transport&nbsp;error&nbsp;has&nbsp;occured.</tt></dd></dl>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500263
264<dl><dt><a name="HttpRequest-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;JSON&nbsp;representation&nbsp;of&nbsp;the&nbsp;<a href="#HttpRequest">HttpRequest</a>.</tt></dd></dl>
265
266<hr>
267Static methods defined here:<br>
268<dl><dt><a name="HttpRequest-from_json"><strong>from_json</strong></a>(s, http, postproc)</dt><dd><tt>Returns&nbsp;an&nbsp;<a href="#HttpRequest">HttpRequest</a>&nbsp;populated&nbsp;with&nbsp;info&nbsp;from&nbsp;a&nbsp;JSON&nbsp;<a href="__builtin__.html#object">object</a>.</tt></dd></dl>
269
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500270<hr>
271Data descriptors defined here:<br>
272<dl><dt><strong>__dict__</strong></dt>
273<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
274</dl>
275<dl><dt><strong>__weakref__</strong></dt>
276<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
277</dl>
278</td></tr></table> <p>
279<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
280<tr bgcolor="#ffc8d8">
281<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400282<font color="#000000" face="helvetica, arial"><a name="HttpRequestMock">class <strong>HttpRequestMock</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
283
284<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
285<td colspan=2><tt>Mock&nbsp;of&nbsp;<a href="#HttpRequest">HttpRequest</a>.<br>
286&nbsp;<br>
287Do&nbsp;not&nbsp;construct&nbsp;directly,&nbsp;instead&nbsp;use&nbsp;<a href="#RequestMockBuilder">RequestMockBuilder</a>.<br>&nbsp;</tt></td></tr>
288<tr><td>&nbsp;</td>
289<td width="100%">Methods defined here:<br>
290<dl><dt><a name="HttpRequestMock-__init__"><strong>__init__</strong></a>(self, resp, content, postproc)</dt><dd><tt>Constructor&nbsp;for&nbsp;<a href="#HttpRequestMock">HttpRequestMock</a><br>
291&nbsp;<br>
292Args:<br>
293&nbsp;&nbsp;resp:&nbsp;httplib2.Response,&nbsp;the&nbsp;response&nbsp;to&nbsp;emulate&nbsp;coming&nbsp;from&nbsp;the&nbsp;request<br>
294&nbsp;&nbsp;content:&nbsp;string,&nbsp;the&nbsp;response&nbsp;body<br>
295&nbsp;&nbsp;postproc:&nbsp;callable,&nbsp;the&nbsp;post&nbsp;processing&nbsp;function&nbsp;usually&nbsp;supplied&nbsp;by<br>
296&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;model&nbsp;class.&nbsp;See&nbsp;model.JsonModel.response()&nbsp;as&nbsp;an&nbsp;example.</tt></dd></dl>
297
298<dl><dt><a name="HttpRequestMock-execute"><strong>execute</strong></a>(self, http<font color="#909090">=None</font>)</dt><dd><tt>Execute&nbsp;the&nbsp;request.<br>
299&nbsp;<br>
300Same&nbsp;behavior&nbsp;as&nbsp;<a href="#HttpRequest">HttpRequest</a>.<a href="#HttpRequestMock-execute">execute</a>(),&nbsp;but&nbsp;the&nbsp;response&nbsp;is<br>
301mocked&nbsp;and&nbsp;not&nbsp;really&nbsp;from&nbsp;an&nbsp;HTTP&nbsp;request/response.</tt></dd></dl>
302
303<hr>
304Data descriptors defined here:<br>
305<dl><dt><strong>__dict__</strong></dt>
306<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
307</dl>
308<dl><dt><strong>__weakref__</strong></dt>
309<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
310</dl>
311</td></tr></table> <p>
312<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
313<tr bgcolor="#ffc8d8">
314<td colspan=3 valign=bottom>&nbsp;<br>
315<font color="#000000" face="helvetica, arial"><a name="MediaFileUpload">class <strong>MediaFileUpload</strong></a>(<a href="apiclient.http.html#MediaUpload">MediaUpload</a>)</font></td></tr>
316
317<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
318<td colspan=2><tt>A&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;for&nbsp;a&nbsp;file.<br>
319&nbsp;<br>
320Construct&nbsp;a&nbsp;<a href="#MediaFileUpload">MediaFileUpload</a>&nbsp;and&nbsp;pass&nbsp;as&nbsp;the&nbsp;media_body&nbsp;parameter&nbsp;of&nbsp;the<br>
321method.&nbsp;For&nbsp;example,&nbsp;if&nbsp;we&nbsp;had&nbsp;a&nbsp;service&nbsp;that&nbsp;allowed&nbsp;uploading&nbsp;images:<br>
322&nbsp;<br>
323&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400324&nbsp;&nbsp;media&nbsp;=&nbsp;<a href="#MediaFileUpload">MediaFileUpload</a>('smiley.png',&nbsp;mimetype='image/png',<br>
325&nbsp;&nbsp;&nbsp;&nbsp;chunksize=1024*1024,&nbsp;resumable=True)<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400326&nbsp;&nbsp;service.objects().insert(<br>
327&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;bucket=buckets['items'][0]['id'],<br>
328&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name='smiley.png',<br>
329&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;media_body=media).execute()<br>&nbsp;</tt></td></tr>
330<tr><td>&nbsp;</td>
331<td width="100%"><dl><dt>Method resolution order:</dt>
332<dd><a href="apiclient.http.html#MediaFileUpload">MediaFileUpload</a></dd>
333<dd><a href="apiclient.http.html#MediaUpload">MediaUpload</a></dd>
334<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
335</dl>
336<hr>
337Methods defined here:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400338<dl><dt><a name="MediaFileUpload-__init__"><strong>__init__</strong></a>(self, filename, mimetype<font color="#909090">=None</font>, chunksize<font color="#909090">=524288</font>, resumable<font color="#909090">=False</font>)</dt><dd><tt>Constructor.<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400339&nbsp;<br>
340Args:<br>
341&nbsp;&nbsp;filename:&nbsp;string,&nbsp;Name&nbsp;of&nbsp;the&nbsp;file.<br>
342&nbsp;&nbsp;mimetype:&nbsp;string,&nbsp;Mime-type&nbsp;of&nbsp;the&nbsp;file.&nbsp;If&nbsp;None&nbsp;then&nbsp;a&nbsp;mime-type&nbsp;will&nbsp;be<br>
343&nbsp;&nbsp;&nbsp;&nbsp;guessed&nbsp;from&nbsp;the&nbsp;file&nbsp;extension.<br>
344&nbsp;&nbsp;chunksize:&nbsp;int,&nbsp;File&nbsp;will&nbsp;be&nbsp;uploaded&nbsp;in&nbsp;chunks&nbsp;of&nbsp;this&nbsp;many&nbsp;bytes.&nbsp;Only<br>
345&nbsp;&nbsp;&nbsp;&nbsp;used&nbsp;if&nbsp;resumable=True.<br>
346&nbsp;&nbsp;resumable:&nbsp;bool,&nbsp;True&nbsp;if&nbsp;this&nbsp;is&nbsp;a&nbsp;resumable&nbsp;upload.&nbsp;False&nbsp;means&nbsp;upload<br>
347&nbsp;&nbsp;&nbsp;&nbsp;in&nbsp;a&nbsp;single&nbsp;request.</tt></dd></dl>
348
Joe Gregorio66212032012-06-14 09:10:14 -0400349<dl><dt><a name="MediaFileUpload-chunksize"><strong>chunksize</strong></a>(self)</dt><dd><tt>Chunk&nbsp;size&nbsp;for&nbsp;resumable&nbsp;uploads.<br>
350&nbsp;<br>
351Returns:<br>
352&nbsp;&nbsp;Chunk&nbsp;size&nbsp;in&nbsp;bytes.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400353
354<dl><dt><a name="MediaFileUpload-getbytes"><strong>getbytes</strong></a>(self, begin, length)</dt><dd><tt>Get&nbsp;bytes&nbsp;from&nbsp;the&nbsp;media.<br>
355&nbsp;<br>
356Args:<br>
357&nbsp;&nbsp;begin:&nbsp;int,&nbsp;offset&nbsp;from&nbsp;beginning&nbsp;of&nbsp;file.<br>
358&nbsp;&nbsp;length:&nbsp;int,&nbsp;number&nbsp;of&nbsp;bytes&nbsp;to&nbsp;read,&nbsp;starting&nbsp;at&nbsp;begin.<br>
359&nbsp;<br>
360Returns:<br>
361&nbsp;&nbsp;A&nbsp;string&nbsp;of&nbsp;bytes&nbsp;read.&nbsp;May&nbsp;be&nbsp;shorted&nbsp;than&nbsp;length&nbsp;if&nbsp;EOF&nbsp;was&nbsp;reached<br>
362&nbsp;&nbsp;first.</tt></dd></dl>
363
Joe Gregorio66212032012-06-14 09:10:14 -0400364<dl><dt><a name="MediaFileUpload-mimetype"><strong>mimetype</strong></a>(self)</dt><dd><tt>Mime&nbsp;type&nbsp;of&nbsp;the&nbsp;body.<br>
365&nbsp;<br>
366Returns:<br>
367&nbsp;&nbsp;Mime&nbsp;type.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400368
Joe Gregorio66212032012-06-14 09:10:14 -0400369<dl><dt><a name="MediaFileUpload-resumable"><strong>resumable</strong></a>(self)</dt><dd><tt>Whether&nbsp;this&nbsp;upload&nbsp;is&nbsp;resumable.<br>
370&nbsp;<br>
371Returns:<br>
372&nbsp;&nbsp;True&nbsp;if&nbsp;resumable&nbsp;upload&nbsp;or&nbsp;False.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400373
Joe Gregorio66212032012-06-14 09:10:14 -0400374<dl><dt><a name="MediaFileUpload-size"><strong>size</strong></a>(self)</dt><dd><tt>Size&nbsp;of&nbsp;upload.<br>
375&nbsp;<br>
376Returns:<br>
377&nbsp;&nbsp;Size&nbsp;of&nbsp;the&nbsp;body,&nbsp;or&nbsp;None&nbsp;of&nbsp;the&nbsp;size&nbsp;is&nbsp;unknown.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400378
379<dl><dt><a name="MediaFileUpload-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Creating&nbsp;a&nbsp;JSON&nbsp;representation&nbsp;of&nbsp;an&nbsp;instance&nbsp;of&nbsp;Credentials.<br>
380&nbsp;<br>
381Returns:<br>
382&nbsp;&nbsp;&nbsp;string,&nbsp;a&nbsp;JSON&nbsp;representation&nbsp;of&nbsp;this&nbsp;instance,&nbsp;suitable&nbsp;to&nbsp;pass&nbsp;to<br>
383&nbsp;&nbsp;&nbsp;<a href="#MediaFileUpload-from_json">from_json</a>().</tt></dd></dl>
384
385<hr>
386Static methods defined here:<br>
387<dl><dt><a name="MediaFileUpload-from_json"><strong>from_json</strong></a>(s)</dt></dl>
388
389<hr>
390Class methods inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
391<dl><dt><a name="MediaFileUpload-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility&nbsp;class&nbsp;method&nbsp;to&nbsp;instantiate&nbsp;a&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;subclass&nbsp;from&nbsp;a&nbsp;JSON<br>
392representation&nbsp;produced&nbsp;by&nbsp;<a href="#MediaFileUpload-to_json">to_json</a>().<br>
393&nbsp;<br>
394Args:<br>
395&nbsp;&nbsp;s:&nbsp;string,&nbsp;JSON&nbsp;from&nbsp;<a href="#MediaFileUpload-to_json">to_json</a>().<br>
396&nbsp;<br>
397Returns:<br>
398&nbsp;&nbsp;An&nbsp;instance&nbsp;of&nbsp;the&nbsp;subclass&nbsp;of&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;that&nbsp;was&nbsp;serialized&nbsp;with<br>
399&nbsp;&nbsp;<a href="#MediaFileUpload-to_json">to_json</a>().</tt></dd></dl>
400
401<hr>
402Data descriptors inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
403<dl><dt><strong>__dict__</strong></dt>
404<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
405</dl>
406<dl><dt><strong>__weakref__</strong></dt>
407<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
408</dl>
409</td></tr></table> <p>
410<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
411<tr bgcolor="#ffc8d8">
412<td colspan=3 valign=bottom>&nbsp;<br>
413<font color="#000000" face="helvetica, arial"><a name="MediaInMemoryUpload">class <strong>MediaInMemoryUpload</strong></a>(<a href="apiclient.http.html#MediaUpload">MediaUpload</a>)</font></td></tr>
414
415<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
416<td colspan=2><tt><a href="#MediaUpload">MediaUpload</a>&nbsp;for&nbsp;a&nbsp;chunk&nbsp;of&nbsp;bytes.<br>
417&nbsp;<br>
418Construct&nbsp;a&nbsp;<a href="#MediaFileUpload">MediaFileUpload</a>&nbsp;and&nbsp;pass&nbsp;as&nbsp;the&nbsp;media_body&nbsp;parameter&nbsp;of&nbsp;the<br>
419method.&nbsp;For&nbsp;example,&nbsp;if&nbsp;we&nbsp;had&nbsp;a&nbsp;service&nbsp;that&nbsp;allowed&nbsp;plain&nbsp;text:<br>&nbsp;</tt></td></tr>
420<tr><td>&nbsp;</td>
421<td width="100%"><dl><dt>Method resolution order:</dt>
422<dd><a href="apiclient.http.html#MediaInMemoryUpload">MediaInMemoryUpload</a></dd>
423<dd><a href="apiclient.http.html#MediaUpload">MediaUpload</a></dd>
424<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
425</dl>
426<hr>
427Methods defined here:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400428<dl><dt><a name="MediaInMemoryUpload-__init__"><strong>__init__</strong></a>(self, body, mimetype<font color="#909090">='application/octet-stream'</font>, chunksize<font color="#909090">=524288</font>, resumable<font color="#909090">=False</font>)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;MediaBytesUpload.<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400429&nbsp;<br>
430Args:<br>
431&nbsp;&nbsp;body:&nbsp;string,&nbsp;Bytes&nbsp;of&nbsp;body&nbsp;content.<br>
432&nbsp;&nbsp;mimetype:&nbsp;string,&nbsp;Mime-type&nbsp;of&nbsp;the&nbsp;file&nbsp;or&nbsp;default&nbsp;of<br>
433&nbsp;&nbsp;&nbsp;&nbsp;'application/octet-stream'.<br>
434&nbsp;&nbsp;chunksize:&nbsp;int,&nbsp;File&nbsp;will&nbsp;be&nbsp;uploaded&nbsp;in&nbsp;chunks&nbsp;of&nbsp;this&nbsp;many&nbsp;bytes.&nbsp;Only<br>
435&nbsp;&nbsp;&nbsp;&nbsp;used&nbsp;if&nbsp;resumable=True.<br>
436&nbsp;&nbsp;resumable:&nbsp;bool,&nbsp;True&nbsp;if&nbsp;this&nbsp;is&nbsp;a&nbsp;resumable&nbsp;upload.&nbsp;False&nbsp;means&nbsp;upload<br>
437&nbsp;&nbsp;&nbsp;&nbsp;in&nbsp;a&nbsp;single&nbsp;request.</tt></dd></dl>
438
439<dl><dt><a name="MediaInMemoryUpload-chunksize"><strong>chunksize</strong></a>(self)</dt><dd><tt>Chunk&nbsp;size&nbsp;for&nbsp;resumable&nbsp;uploads.<br>
440&nbsp;<br>
441Returns:<br>
442&nbsp;&nbsp;Chunk&nbsp;size&nbsp;in&nbsp;bytes.</tt></dd></dl>
443
444<dl><dt><a name="MediaInMemoryUpload-getbytes"><strong>getbytes</strong></a>(self, begin, length)</dt><dd><tt>Get&nbsp;bytes&nbsp;from&nbsp;the&nbsp;media.<br>
445&nbsp;<br>
446Args:<br>
447&nbsp;&nbsp;begin:&nbsp;int,&nbsp;offset&nbsp;from&nbsp;beginning&nbsp;of&nbsp;file.<br>
448&nbsp;&nbsp;length:&nbsp;int,&nbsp;number&nbsp;of&nbsp;bytes&nbsp;to&nbsp;read,&nbsp;starting&nbsp;at&nbsp;begin.<br>
449&nbsp;<br>
450Returns:<br>
451&nbsp;&nbsp;A&nbsp;string&nbsp;of&nbsp;bytes&nbsp;read.&nbsp;May&nbsp;be&nbsp;shorter&nbsp;than&nbsp;length&nbsp;if&nbsp;EOF&nbsp;was&nbsp;reached<br>
452&nbsp;&nbsp;first.</tt></dd></dl>
453
454<dl><dt><a name="MediaInMemoryUpload-mimetype"><strong>mimetype</strong></a>(self)</dt><dd><tt>Mime&nbsp;type&nbsp;of&nbsp;the&nbsp;body.<br>
455&nbsp;<br>
456Returns:<br>
457&nbsp;&nbsp;Mime&nbsp;type.</tt></dd></dl>
458
459<dl><dt><a name="MediaInMemoryUpload-resumable"><strong>resumable</strong></a>(self)</dt><dd><tt>Whether&nbsp;this&nbsp;upload&nbsp;is&nbsp;resumable.<br>
460&nbsp;<br>
461Returns:<br>
462&nbsp;&nbsp;True&nbsp;if&nbsp;resumable&nbsp;upload&nbsp;or&nbsp;False.</tt></dd></dl>
463
464<dl><dt><a name="MediaInMemoryUpload-size"><strong>size</strong></a>(self)</dt><dd><tt>Size&nbsp;of&nbsp;upload.<br>
465&nbsp;<br>
466Returns:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400467&nbsp;&nbsp;Size&nbsp;of&nbsp;the&nbsp;body,&nbsp;or&nbsp;None&nbsp;of&nbsp;the&nbsp;size&nbsp;is&nbsp;unknown.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400468
469<dl><dt><a name="MediaInMemoryUpload-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Create&nbsp;a&nbsp;JSON&nbsp;representation&nbsp;of&nbsp;a&nbsp;<a href="#MediaInMemoryUpload">MediaInMemoryUpload</a>.<br>
470&nbsp;<br>
471Returns:<br>
472&nbsp;&nbsp;&nbsp;string,&nbsp;a&nbsp;JSON&nbsp;representation&nbsp;of&nbsp;this&nbsp;instance,&nbsp;suitable&nbsp;to&nbsp;pass&nbsp;to<br>
473&nbsp;&nbsp;&nbsp;<a href="#MediaInMemoryUpload-from_json">from_json</a>().</tt></dd></dl>
474
475<hr>
476Static methods defined here:<br>
477<dl><dt><a name="MediaInMemoryUpload-from_json"><strong>from_json</strong></a>(s)</dt></dl>
478
479<hr>
480Class methods inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
481<dl><dt><a name="MediaInMemoryUpload-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility&nbsp;class&nbsp;method&nbsp;to&nbsp;instantiate&nbsp;a&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;subclass&nbsp;from&nbsp;a&nbsp;JSON<br>
482representation&nbsp;produced&nbsp;by&nbsp;<a href="#MediaInMemoryUpload-to_json">to_json</a>().<br>
483&nbsp;<br>
484Args:<br>
485&nbsp;&nbsp;s:&nbsp;string,&nbsp;JSON&nbsp;from&nbsp;<a href="#MediaInMemoryUpload-to_json">to_json</a>().<br>
486&nbsp;<br>
487Returns:<br>
488&nbsp;&nbsp;An&nbsp;instance&nbsp;of&nbsp;the&nbsp;subclass&nbsp;of&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;that&nbsp;was&nbsp;serialized&nbsp;with<br>
489&nbsp;&nbsp;<a href="#MediaInMemoryUpload-to_json">to_json</a>().</tt></dd></dl>
490
491<hr>
492Data descriptors inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
493<dl><dt><strong>__dict__</strong></dt>
494<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
495</dl>
496<dl><dt><strong>__weakref__</strong></dt>
497<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
498</dl>
499</td></tr></table> <p>
500<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
501<tr bgcolor="#ffc8d8">
502<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400503<font color="#000000" face="helvetica, arial"><a name="MediaIoBaseUpload">class <strong>MediaIoBaseUpload</strong></a>(<a href="apiclient.http.html#MediaUpload">MediaUpload</a>)</font></td></tr>
504
505<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
506<td colspan=2><tt>A&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;for&nbsp;a&nbsp;io.Base&nbsp;objects.<br>
507&nbsp;<br>
508Note&nbsp;that&nbsp;the&nbsp;Python&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;is&nbsp;compatible&nbsp;with&nbsp;io.Base&nbsp;and&nbsp;can&nbsp;be&nbsp;used<br>
509with&nbsp;this&nbsp;class&nbsp;also.<br>
510&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400511&nbsp;&nbsp;fh&nbsp;=&nbsp;io.BytesIO('...Some&nbsp;data&nbsp;to&nbsp;upload...')<br>
512&nbsp;&nbsp;media&nbsp;=&nbsp;<a href="#MediaIoBaseUpload">MediaIoBaseUpload</a>(fh,&nbsp;mimetype='image/png',<br>
513&nbsp;&nbsp;&nbsp;&nbsp;chunksize=1024*1024,&nbsp;resumable=True)<br>
514&nbsp;&nbsp;service.objects().insert(<br>
515&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;bucket='a_bucket_id',<br>
516&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name='smiley.png',<br>
517&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;media_body=media).execute()<br>&nbsp;</tt></td></tr>
518<tr><td>&nbsp;</td>
519<td width="100%"><dl><dt>Method resolution order:</dt>
520<dd><a href="apiclient.http.html#MediaIoBaseUpload">MediaIoBaseUpload</a></dd>
521<dd><a href="apiclient.http.html#MediaUpload">MediaUpload</a></dd>
522<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
523</dl>
524<hr>
525Methods defined here:<br>
526<dl><dt><a name="MediaIoBaseUpload-__init__"><strong>__init__</strong></a>(self, fh, mimetype, chunksize<font color="#909090">=524288</font>, resumable<font color="#909090">=False</font>)</dt><dd><tt>Constructor.<br>
527&nbsp;<br>
528Args:<br>
Joe Gregorio746096f2012-06-15 10:53:36 -0400529&nbsp;&nbsp;fh:&nbsp;io.Base&nbsp;or&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;The&nbsp;source&nbsp;of&nbsp;the&nbsp;bytes&nbsp;to&nbsp;upload.&nbsp;MUST&nbsp;be<br>
530&nbsp;&nbsp;&nbsp;&nbsp;opened&nbsp;in&nbsp;blocking&nbsp;mode,&nbsp;do&nbsp;not&nbsp;use&nbsp;streams&nbsp;opened&nbsp;in&nbsp;non-blocking&nbsp;mode.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400531&nbsp;&nbsp;mimetype:&nbsp;string,&nbsp;Mime-type&nbsp;of&nbsp;the&nbsp;file.&nbsp;If&nbsp;None&nbsp;then&nbsp;a&nbsp;mime-type&nbsp;will&nbsp;be<br>
532&nbsp;&nbsp;&nbsp;&nbsp;guessed&nbsp;from&nbsp;the&nbsp;file&nbsp;extension.<br>
533&nbsp;&nbsp;chunksize:&nbsp;int,&nbsp;File&nbsp;will&nbsp;be&nbsp;uploaded&nbsp;in&nbsp;chunks&nbsp;of&nbsp;this&nbsp;many&nbsp;bytes.&nbsp;Only<br>
534&nbsp;&nbsp;&nbsp;&nbsp;used&nbsp;if&nbsp;resumable=True.<br>
535&nbsp;&nbsp;resumable:&nbsp;bool,&nbsp;True&nbsp;if&nbsp;this&nbsp;is&nbsp;a&nbsp;resumable&nbsp;upload.&nbsp;False&nbsp;means&nbsp;upload<br>
536&nbsp;&nbsp;&nbsp;&nbsp;in&nbsp;a&nbsp;single&nbsp;request.</tt></dd></dl>
537
538<dl><dt><a name="MediaIoBaseUpload-chunksize"><strong>chunksize</strong></a>(self)</dt><dd><tt>Chunk&nbsp;size&nbsp;for&nbsp;resumable&nbsp;uploads.<br>
539&nbsp;<br>
540Returns:<br>
541&nbsp;&nbsp;Chunk&nbsp;size&nbsp;in&nbsp;bytes.</tt></dd></dl>
542
543<dl><dt><a name="MediaIoBaseUpload-getbytes"><strong>getbytes</strong></a>(self, begin, length)</dt><dd><tt>Get&nbsp;bytes&nbsp;from&nbsp;the&nbsp;media.<br>
544&nbsp;<br>
545Args:<br>
546&nbsp;&nbsp;begin:&nbsp;int,&nbsp;offset&nbsp;from&nbsp;beginning&nbsp;of&nbsp;file.<br>
547&nbsp;&nbsp;length:&nbsp;int,&nbsp;number&nbsp;of&nbsp;bytes&nbsp;to&nbsp;read,&nbsp;starting&nbsp;at&nbsp;begin.<br>
548&nbsp;<br>
549Returns:<br>
550&nbsp;&nbsp;A&nbsp;string&nbsp;of&nbsp;bytes&nbsp;read.&nbsp;May&nbsp;be&nbsp;shorted&nbsp;than&nbsp;length&nbsp;if&nbsp;EOF&nbsp;was&nbsp;reached<br>
551&nbsp;&nbsp;first.</tt></dd></dl>
552
553<dl><dt><a name="MediaIoBaseUpload-mimetype"><strong>mimetype</strong></a>(self)</dt><dd><tt>Mime&nbsp;type&nbsp;of&nbsp;the&nbsp;body.<br>
554&nbsp;<br>
555Returns:<br>
556&nbsp;&nbsp;Mime&nbsp;type.</tt></dd></dl>
557
558<dl><dt><a name="MediaIoBaseUpload-resumable"><strong>resumable</strong></a>(self)</dt><dd><tt>Whether&nbsp;this&nbsp;upload&nbsp;is&nbsp;resumable.<br>
559&nbsp;<br>
560Returns:<br>
561&nbsp;&nbsp;True&nbsp;if&nbsp;resumable&nbsp;upload&nbsp;or&nbsp;False.</tt></dd></dl>
562
563<dl><dt><a name="MediaIoBaseUpload-size"><strong>size</strong></a>(self)</dt><dd><tt>Size&nbsp;of&nbsp;upload.<br>
564&nbsp;<br>
565Returns:<br>
566&nbsp;&nbsp;Size&nbsp;of&nbsp;the&nbsp;body,&nbsp;or&nbsp;None&nbsp;of&nbsp;the&nbsp;size&nbsp;is&nbsp;unknown.</tt></dd></dl>
567
568<dl><dt><a name="MediaIoBaseUpload-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>This&nbsp;upload&nbsp;type&nbsp;is&nbsp;not&nbsp;serializable.</tt></dd></dl>
569
570<hr>
571Class methods inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
572<dl><dt><a name="MediaIoBaseUpload-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility&nbsp;class&nbsp;method&nbsp;to&nbsp;instantiate&nbsp;a&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;subclass&nbsp;from&nbsp;a&nbsp;JSON<br>
573representation&nbsp;produced&nbsp;by&nbsp;<a href="#MediaIoBaseUpload-to_json">to_json</a>().<br>
574&nbsp;<br>
575Args:<br>
576&nbsp;&nbsp;s:&nbsp;string,&nbsp;JSON&nbsp;from&nbsp;<a href="#MediaIoBaseUpload-to_json">to_json</a>().<br>
577&nbsp;<br>
578Returns:<br>
579&nbsp;&nbsp;An&nbsp;instance&nbsp;of&nbsp;the&nbsp;subclass&nbsp;of&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;that&nbsp;was&nbsp;serialized&nbsp;with<br>
580&nbsp;&nbsp;<a href="#MediaIoBaseUpload-to_json">to_json</a>().</tt></dd></dl>
581
582<hr>
583Data descriptors inherited from <a href="apiclient.http.html#MediaUpload">MediaUpload</a>:<br>
584<dl><dt><strong>__dict__</strong></dt>
585<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
586</dl>
587<dl><dt><strong>__weakref__</strong></dt>
588<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
589</dl>
590</td></tr></table> <p>
591<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
592<tr bgcolor="#ffc8d8">
593<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400594<font color="#000000" face="helvetica, arial"><a name="MediaUpload">class <strong>MediaUpload</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
595
596<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
597<td colspan=2><tt>Describes&nbsp;a&nbsp;media&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;to&nbsp;upload.<br>
598&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400599Base&nbsp;class&nbsp;that&nbsp;defines&nbsp;the&nbsp;interface&nbsp;of&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;subclasses.<br>
600&nbsp;<br>
601Note&nbsp;that&nbsp;subclasses&nbsp;of&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;may&nbsp;allow&nbsp;you&nbsp;to&nbsp;control&nbsp;the&nbsp;chunksize<br>
602when&nbsp;upload&nbsp;a&nbsp;media&nbsp;<a href="__builtin__.html#object">object</a>.&nbsp;It&nbsp;is&nbsp;important&nbsp;to&nbsp;keep&nbsp;the&nbsp;size&nbsp;of&nbsp;the&nbsp;chunk&nbsp;as<br>
603large&nbsp;as&nbsp;possible&nbsp;to&nbsp;keep&nbsp;the&nbsp;upload&nbsp;efficient.&nbsp;Other&nbsp;factors&nbsp;may&nbsp;influence<br>
604the&nbsp;size&nbsp;of&nbsp;the&nbsp;chunk&nbsp;you&nbsp;use,&nbsp;particularly&nbsp;if&nbsp;you&nbsp;are&nbsp;working&nbsp;in&nbsp;an<br>
605environment&nbsp;where&nbsp;individual&nbsp;HTTP&nbsp;requests&nbsp;may&nbsp;have&nbsp;a&nbsp;hardcoded&nbsp;time&nbsp;limit,<br>
606such&nbsp;as&nbsp;under&nbsp;certain&nbsp;classes&nbsp;of&nbsp;requests&nbsp;under&nbsp;Google&nbsp;App&nbsp;Engine.<br>&nbsp;</tt></td></tr>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400607<tr><td>&nbsp;</td>
608<td width="100%">Methods defined here:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400609<dl><dt><a name="MediaUpload-chunksize"><strong>chunksize</strong></a>(self)</dt><dd><tt>Chunk&nbsp;size&nbsp;for&nbsp;resumable&nbsp;uploads.<br>
610&nbsp;<br>
611Returns:<br>
612&nbsp;&nbsp;Chunk&nbsp;size&nbsp;in&nbsp;bytes.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400613
Joe Gregorio66212032012-06-14 09:10:14 -0400614<dl><dt><a name="MediaUpload-getbytes"><strong>getbytes</strong></a>(self, begin, end)</dt><dd><tt>Get&nbsp;bytes&nbsp;from&nbsp;the&nbsp;media.<br>
615&nbsp;<br>
616Args:<br>
617&nbsp;&nbsp;begin:&nbsp;int,&nbsp;offset&nbsp;from&nbsp;beginning&nbsp;of&nbsp;file.<br>
618&nbsp;&nbsp;length:&nbsp;int,&nbsp;number&nbsp;of&nbsp;bytes&nbsp;to&nbsp;read,&nbsp;starting&nbsp;at&nbsp;begin.<br>
619&nbsp;<br>
620Returns:<br>
621&nbsp;&nbsp;A&nbsp;string&nbsp;of&nbsp;bytes&nbsp;read.&nbsp;May&nbsp;be&nbsp;shorter&nbsp;than&nbsp;length&nbsp;if&nbsp;EOF&nbsp;was&nbsp;reached<br>
622&nbsp;&nbsp;first.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400623
Joe Gregorio66212032012-06-14 09:10:14 -0400624<dl><dt><a name="MediaUpload-mimetype"><strong>mimetype</strong></a>(self)</dt><dd><tt>Mime&nbsp;type&nbsp;of&nbsp;the&nbsp;body.<br>
625&nbsp;<br>
626Returns:<br>
627&nbsp;&nbsp;Mime&nbsp;type.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400628
Joe Gregorio66212032012-06-14 09:10:14 -0400629<dl><dt><a name="MediaUpload-resumable"><strong>resumable</strong></a>(self)</dt><dd><tt>Whether&nbsp;this&nbsp;upload&nbsp;is&nbsp;resumable.<br>
630&nbsp;<br>
631Returns:<br>
632&nbsp;&nbsp;True&nbsp;if&nbsp;resumable&nbsp;upload&nbsp;or&nbsp;False.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400633
Joe Gregorio66212032012-06-14 09:10:14 -0400634<dl><dt><a name="MediaUpload-size"><strong>size</strong></a>(self)</dt><dd><tt>Size&nbsp;of&nbsp;upload.<br>
635&nbsp;<br>
636Returns:<br>
637&nbsp;&nbsp;Size&nbsp;of&nbsp;the&nbsp;body,&nbsp;or&nbsp;None&nbsp;of&nbsp;the&nbsp;size&nbsp;is&nbsp;unknown.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400638
639<dl><dt><a name="MediaUpload-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Create&nbsp;a&nbsp;JSON&nbsp;representation&nbsp;of&nbsp;an&nbsp;instance&nbsp;of&nbsp;<a href="#MediaUpload">MediaUpload</a>.<br>
640&nbsp;<br>
641Returns:<br>
642&nbsp;&nbsp;&nbsp;string,&nbsp;a&nbsp;JSON&nbsp;representation&nbsp;of&nbsp;this&nbsp;instance,&nbsp;suitable&nbsp;to&nbsp;pass&nbsp;to<br>
643&nbsp;&nbsp;&nbsp;from_json().</tt></dd></dl>
644
645<hr>
646Class methods defined here:<br>
647<dl><dt><a name="MediaUpload-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility&nbsp;class&nbsp;method&nbsp;to&nbsp;instantiate&nbsp;a&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;subclass&nbsp;from&nbsp;a&nbsp;JSON<br>
648representation&nbsp;produced&nbsp;by&nbsp;<a href="#MediaUpload-to_json">to_json</a>().<br>
649&nbsp;<br>
650Args:<br>
651&nbsp;&nbsp;s:&nbsp;string,&nbsp;JSON&nbsp;from&nbsp;<a href="#MediaUpload-to_json">to_json</a>().<br>
652&nbsp;<br>
653Returns:<br>
654&nbsp;&nbsp;An&nbsp;instance&nbsp;of&nbsp;the&nbsp;subclass&nbsp;of&nbsp;<a href="#MediaUpload">MediaUpload</a>&nbsp;that&nbsp;was&nbsp;serialized&nbsp;with<br>
655&nbsp;&nbsp;<a href="#MediaUpload-to_json">to_json</a>().</tt></dd></dl>
656
657<hr>
658Data descriptors defined here:<br>
659<dl><dt><strong>__dict__</strong></dt>
660<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
661</dl>
662<dl><dt><strong>__weakref__</strong></dt>
663<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
664</dl>
665</td></tr></table> <p>
666<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
667<tr bgcolor="#ffc8d8">
668<td colspan=3 valign=bottom>&nbsp;<br>
669<font color="#000000" face="helvetica, arial"><a name="MediaUploadProgress">class <strong>MediaUploadProgress</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
670
671<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
672<td colspan=2><tt>Status&nbsp;of&nbsp;a&nbsp;resumable&nbsp;upload.<br>&nbsp;</tt></td></tr>
673<tr><td>&nbsp;</td>
674<td width="100%">Methods defined here:<br>
675<dl><dt><a name="MediaUploadProgress-__init__"><strong>__init__</strong></a>(self, resumable_progress, total_size)</dt><dd><tt>Constructor.<br>
676&nbsp;<br>
677Args:<br>
678&nbsp;&nbsp;resumable_progress:&nbsp;int,&nbsp;bytes&nbsp;sent&nbsp;so&nbsp;far.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400679&nbsp;&nbsp;total_size:&nbsp;int,&nbsp;total&nbsp;bytes&nbsp;in&nbsp;complete&nbsp;upload,&nbsp;or&nbsp;None&nbsp;if&nbsp;the&nbsp;total<br>
680&nbsp;&nbsp;&nbsp;&nbsp;upload&nbsp;size&nbsp;isn't&nbsp;known&nbsp;ahead&nbsp;of&nbsp;time.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400681
Joe Gregorio66212032012-06-14 09:10:14 -0400682<dl><dt><a name="MediaUploadProgress-progress"><strong>progress</strong></a>(self)</dt><dd><tt>Percent&nbsp;of&nbsp;upload&nbsp;completed,&nbsp;as&nbsp;a&nbsp;float.<br>
683&nbsp;<br>
684Returns:<br>
685&nbsp;&nbsp;the&nbsp;percentage&nbsp;complete&nbsp;as&nbsp;a&nbsp;float,&nbsp;returning&nbsp;0.0&nbsp;if&nbsp;the&nbsp;total&nbsp;size&nbsp;of<br>
686&nbsp;&nbsp;the&nbsp;upload&nbsp;is&nbsp;unknown.</tt></dd></dl>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400687
688<hr>
689Data descriptors defined here:<br>
690<dl><dt><strong>__dict__</strong></dt>
691<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
692</dl>
693<dl><dt><strong>__weakref__</strong></dt>
694<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
695</dl>
696</td></tr></table> <p>
697<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
698<tr bgcolor="#ffc8d8">
699<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500700<font color="#000000" face="helvetica, arial"><a name="RequestMockBuilder">class <strong>RequestMockBuilder</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
701
702<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
703<td colspan=2><tt>A&nbsp;simple&nbsp;mock&nbsp;of&nbsp;<a href="#HttpRequest">HttpRequest</a><br>
704&nbsp;<br>
705Pass&nbsp;in&nbsp;a&nbsp;dictionary&nbsp;to&nbsp;the&nbsp;constructor&nbsp;that&nbsp;maps&nbsp;request&nbsp;methodIds&nbsp;to<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400706tuples&nbsp;of&nbsp;(httplib2.Response,&nbsp;content,&nbsp;opt_expected_body)&nbsp;that&nbsp;should&nbsp;be<br>
707returned&nbsp;when&nbsp;that&nbsp;method&nbsp;is&nbsp;called.&nbsp;None&nbsp;may&nbsp;also&nbsp;be&nbsp;passed&nbsp;in&nbsp;for&nbsp;the<br>
708httplib2.Response,&nbsp;in&nbsp;which&nbsp;case&nbsp;a&nbsp;200&nbsp;OK&nbsp;response&nbsp;will&nbsp;be&nbsp;generated.<br>
709If&nbsp;an&nbsp;opt_expected_body&nbsp;(str&nbsp;or&nbsp;dict)&nbsp;is&nbsp;provided,&nbsp;it&nbsp;will&nbsp;be&nbsp;compared&nbsp;to<br>
710the&nbsp;body&nbsp;and&nbsp;UnexpectedBodyError&nbsp;will&nbsp;be&nbsp;raised&nbsp;on&nbsp;inequality.<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500711&nbsp;<br>
712Example:<br>
713&nbsp;&nbsp;response&nbsp;=&nbsp;'{"data":&nbsp;{"id":&nbsp;"tag:google.c...'<br>
714&nbsp;&nbsp;requestBuilder&nbsp;=&nbsp;<a href="#RequestMockBuilder">RequestMockBuilder</a>(<br>
715&nbsp;&nbsp;&nbsp;&nbsp;{<br>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500716&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'plus.activities.get':&nbsp;(None,&nbsp;response),<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500717&nbsp;&nbsp;&nbsp;&nbsp;}<br>
718&nbsp;&nbsp;)<br>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500719&nbsp;&nbsp;apiclient.discovery.build("plus",&nbsp;"v1",&nbsp;requestBuilder=requestBuilder)<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500720&nbsp;<br>
721Methods&nbsp;that&nbsp;you&nbsp;do&nbsp;not&nbsp;supply&nbsp;a&nbsp;response&nbsp;for&nbsp;will&nbsp;return&nbsp;a<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500722200&nbsp;OK&nbsp;with&nbsp;an&nbsp;empty&nbsp;string&nbsp;as&nbsp;the&nbsp;response&nbsp;content&nbsp;or&nbsp;raise&nbsp;an&nbsp;excpetion<br>
723if&nbsp;check_unexpected&nbsp;is&nbsp;set&nbsp;to&nbsp;True.&nbsp;The&nbsp;methodId&nbsp;is&nbsp;taken&nbsp;from&nbsp;the&nbsp;rpcName<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400724in&nbsp;the&nbsp;discovery&nbsp;document.<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500725&nbsp;<br>
726For&nbsp;more&nbsp;details&nbsp;see&nbsp;the&nbsp;project&nbsp;wiki.<br>&nbsp;</tt></td></tr>
727<tr><td>&nbsp;</td>
728<td width="100%">Methods defined here:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500729<dl><dt><a name="RequestMockBuilder-__call__"><strong>__call__</strong></a>(self, http, postproc, uri, method<font color="#909090">='GET'</font>, body<font color="#909090">=None</font>, headers<font color="#909090">=None</font>, methodId<font color="#909090">=None</font>, resumable<font color="#909090">=None</font>)</dt><dd><tt>Implements&nbsp;the&nbsp;callable&nbsp;interface&nbsp;that&nbsp;discovery.build()&nbsp;expects<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500730of&nbsp;requestBuilder,&nbsp;which&nbsp;is&nbsp;to&nbsp;build&nbsp;an&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;compatible&nbsp;with<br>
731<a href="#HttpRequest">HttpRequest</a>.execute().&nbsp;See&nbsp;that&nbsp;method&nbsp;for&nbsp;the&nbsp;description&nbsp;of&nbsp;the<br>
732parameters&nbsp;and&nbsp;the&nbsp;expected&nbsp;response.</tt></dd></dl>
733
Joe Gregorioa8451672011-09-15 09:53:21 -0400734<dl><dt><a name="RequestMockBuilder-__init__"><strong>__init__</strong></a>(self, responses, check_unexpected<font color="#909090">=False</font>)</dt><dd><tt>Constructor&nbsp;for&nbsp;<a href="#RequestMockBuilder">RequestMockBuilder</a><br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500735&nbsp;<br>
736The&nbsp;constructed&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;should&nbsp;be&nbsp;a&nbsp;callable&nbsp;<a href="__builtin__.html#object">object</a><br>
737that&nbsp;can&nbsp;replace&nbsp;the&nbsp;class&nbsp;HttpResponse.<br>
738&nbsp;<br>
739responses&nbsp;-&nbsp;A&nbsp;dictionary&nbsp;that&nbsp;maps&nbsp;methodIds&nbsp;into&nbsp;tuples<br>
740&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;(httplib2.Response,&nbsp;content).&nbsp;The&nbsp;methodId<br>
741&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;comes&nbsp;from&nbsp;the&nbsp;'rpcName'&nbsp;field&nbsp;in&nbsp;the&nbsp;discovery<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400742&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;document.<br>
743check_unexpected&nbsp;-&nbsp;A&nbsp;boolean&nbsp;setting&nbsp;whether&nbsp;or&nbsp;not&nbsp;UnexpectedMethodError<br>
744&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;should&nbsp;be&nbsp;raised&nbsp;on&nbsp;unsupplied&nbsp;method.</tt></dd></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500745
746<hr>
747Data descriptors defined here:<br>
748<dl><dt><strong>__dict__</strong></dt>
749<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
750</dl>
751<dl><dt><strong>__weakref__</strong></dt>
752<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
753</dl>
754</td></tr></table></td></tr></table><p>
755<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400756<tr bgcolor="#eeaa77">
757<td colspan=3 valign=bottom>&nbsp;<br>
758<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
759
760<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregoriod9d00902012-04-13 07:58:30 -0400761<td width="100%"><dl><dt><a name="-set_user_agent"><strong>set_user_agent</strong></a>(http, user_agent)</dt><dd><tt>Set&nbsp;the&nbsp;user-agent&nbsp;on&nbsp;every&nbsp;request.<br>
762&nbsp;<br>
763Args:<br>
764&nbsp;&nbsp;&nbsp;http&nbsp;-&nbsp;An&nbsp;instance&nbsp;of&nbsp;httplib2.Http<br>
765&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;something&nbsp;that&nbsp;acts&nbsp;like&nbsp;it.<br>
766&nbsp;&nbsp;&nbsp;user_agent:&nbsp;string,&nbsp;the&nbsp;value&nbsp;for&nbsp;the&nbsp;user-agent&nbsp;header.<br>
767&nbsp;<br>
768Returns:<br>
769&nbsp;&nbsp;&nbsp;A&nbsp;modified&nbsp;instance&nbsp;of&nbsp;http&nbsp;that&nbsp;was&nbsp;passed&nbsp;in.<br>
770&nbsp;<br>
771Example:<br>
772&nbsp;<br>
773&nbsp;&nbsp;h&nbsp;=&nbsp;httplib2.Http()<br>
774&nbsp;&nbsp;h&nbsp;=&nbsp;<a href="#-set_user_agent">set_user_agent</a>(h,&nbsp;"my-app-name/6.0")<br>
775&nbsp;<br>
776Most&nbsp;of&nbsp;the&nbsp;time&nbsp;the&nbsp;user-agent&nbsp;will&nbsp;be&nbsp;set&nbsp;doing&nbsp;auth,&nbsp;this&nbsp;is&nbsp;for&nbsp;the&nbsp;rare<br>
777cases&nbsp;where&nbsp;you&nbsp;are&nbsp;accessing&nbsp;an&nbsp;unauthenticated&nbsp;endpoint.</tt></dd></dl>
778 <dl><dt><a name="-tunnel_patch"><strong>tunnel_patch</strong></a>(http)</dt><dd><tt>Tunnel&nbsp;PATCH&nbsp;requests&nbsp;over&nbsp;POST.<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400779Args:<br>
780&nbsp;&nbsp;&nbsp;http&nbsp;-&nbsp;An&nbsp;instance&nbsp;of&nbsp;httplib2.Http<br>
781&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;something&nbsp;that&nbsp;acts&nbsp;like&nbsp;it.<br>
782&nbsp;<br>
783Returns:<br>
784&nbsp;&nbsp;&nbsp;A&nbsp;modified&nbsp;instance&nbsp;of&nbsp;http&nbsp;that&nbsp;was&nbsp;passed&nbsp;in.<br>
785&nbsp;<br>
786Example:<br>
787&nbsp;<br>
788&nbsp;&nbsp;h&nbsp;=&nbsp;httplib2.Http()<br>
789&nbsp;&nbsp;h&nbsp;=&nbsp;<a href="#-tunnel_patch">tunnel_patch</a>(h,&nbsp;"my-app-name/6.0")<br>
790&nbsp;<br>
791Useful&nbsp;if&nbsp;you&nbsp;are&nbsp;running&nbsp;on&nbsp;a&nbsp;platform&nbsp;that&nbsp;doesn't&nbsp;support&nbsp;PATCH.<br>
792Apply&nbsp;this&nbsp;last&nbsp;if&nbsp;you&nbsp;are&nbsp;using&nbsp;OAuth&nbsp;1.0,&nbsp;as&nbsp;changing&nbsp;the&nbsp;method<br>
793will&nbsp;result&nbsp;in&nbsp;a&nbsp;different&nbsp;signature.</tt></dd></dl>
794</td></tr></table><p>
795<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500796<tr bgcolor="#55aa55">
797<td colspan=3 valign=bottom>&nbsp;<br>
798<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
799
800<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio66212032012-06-14 09:10:14 -0400801<td width="100%"><strong>DEFAULT_CHUNK_SIZE</strong> = 524288<br>
802<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500803<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
804<tr bgcolor="#7799ee">
805<td colspan=3 valign=bottom>&nbsp;<br>
806<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
807
808<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
809<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
810</body></html>