Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 44454e4c65dda5a2a811553e1cc540140c039fd5 / . / docs / epy / apiclient.http.HttpRequest-class.html
blob: 9f6c8e1191e606cc58d1fecdd5ddcfddc10688ba [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.HttpRequest</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;HttpRequest
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.HttpRequest-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 HttpRequest</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_apiclien_15" name="uml_class_diagram_for_apiclien_15">
59<area shape="rect" href="apiclient.http.HttpRequest-class.html#__init__" title="Constructor for an HttpRequest." alt="" coords="17,36,665,55"/>
60<area shape="rect" href="apiclient.http.HttpRequest-class.html#execute" title="Execute the request." alt="" coords="17,55,665,73"/>
61<area shape="rect" href="apiclient.http.HttpRequest-class.html#next_chunk" title="Execute the next step of a resumable upload." alt="" coords="17,73,665,92"/>
62<area shape="rect" href="apiclient.http.HttpRequest-class.html#to_json" title="Returns a JSON representation of the HttpRequest." alt="" coords="17,92,665,111"/>
63<area shape="rect" href="apiclient.http.HttpRequest-class.html#from_json" title="Returns an HttpRequest populated with info from a JSON object." alt="" coords="17,111,665,129"/>
64<area shape="rect" href="apiclient.http.HttpRequest-class.html" title="Encapsulates a single HTTP request." alt="" coords="16,11,667,131"/>
65</map>
66 <img src="uml_class_diagram_for_apiclien_15.gif" alt='' usemap="#uml_class_diagram_for_apiclien_15" ismap="ismap" class="graph-without-title" />
67</center>
68</center>
69<hr />
70<pre class="literalblock">
71Encapsulates a single HTTP request.
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>
98 <td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
99 <span class="summary-sig-arg">http</span>,
100 <span class="summary-sig-arg">postproc</span>,
101 <span class="summary-sig-arg">uri</span>,
102 <span class="summary-sig-arg">method</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">GET</code><code class="variable-quote">'</code></span>,
103 <span class="summary-sig-arg">body</span>=<span class="summary-sig-default">None</span>,
104 <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">None</span>,
105 <span class="summary-sig-arg">methodId</span>=<span class="summary-sig-default">None</span>,
106 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-default">None</span>)</span><br />
107 Constructor for an HttpRequest.</td>
108 <td align="right" valign="top">
109 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.__init__">source&nbsp;code</a></span>
110
111 </td>
112 </tr>
113 </table>
114
115 </td>
116 </tr>
117<tr>
118 <td width="15%" align="right" valign="top" class="summary">
119 <span class="summary-type">&nbsp;</span>
120 </td><td class="summary">
121 <table width="100%" cellpadding="0" cellspacing="0" border="0">
122 <tr>
123 <td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
124 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>)</span><br />
125 Execute the request.</td>
126 <td align="right" valign="top">
127 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.execute">source&nbsp;code</a></span>
128
129 </td>
130 </tr>
131 </table>
132
133 </td>
134 </tr>
135<tr>
136 <td width="15%" align="right" valign="top" class="summary">
137 <span class="summary-type">&nbsp;</span>
138 </td><td class="summary">
139 <table width="100%" cellpadding="0" cellspacing="0" border="0">
140 <tr>
141 <td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#next_chunk" class="summary-sig-name">next_chunk</a>(<span class="summary-sig-arg">self</span>,
142 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>)</span><br />
143 Execute the next step of a resumable upload.</td>
144 <td align="right" valign="top">
145 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.next_chunk">source&nbsp;code</a></span>
146
147 </td>
148 </tr>
149 </table>
150
151 </td>
152 </tr>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]153<tr class="private">
154 <td width="15%" align="right" valign="top" class="summary">
155 <span class="summary-type">&nbsp;</span>
156 </td><td class="summary">
157 <table width="100%" cellpadding="0" cellspacing="0" border="0">
158 <tr>
159 <td><span class="summary-sig"><a href="apiclient.http.HttpRequest-class.html#_process_response" class="summary-sig-name" onclick="show_private();">_process_response</a>(<span class="summary-sig-arg">self</span>,
160 <span class="summary-sig-arg">resp</span>,
161 <span class="summary-sig-arg">content</span>)</span><br />
162 Process the response from a single chunk upload.</td>
163 <td align="right" valign="top">
164 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest._process_response">source&nbsp;code</a></span>
165
166 </td>
167 </tr>
168 </table>
169
170 </td>
171 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]172<tr>
173 <td width="15%" align="right" valign="top" class="summary">
174 <span class="summary-type">&nbsp;</span>
175 </td><td class="summary">
176 <table width="100%" cellpadding="0" cellspacing="0" border="0">
177 <tr>
178 <td><span class="summary-sig"><a name="to_json"></a><span class="summary-sig-name">to_json</span>(<span class="summary-sig-arg">self</span>)</span><br />
179 Returns a JSON representation of the HttpRequest.</td>
180 <td align="right" valign="top">
181 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.to_json">source&nbsp;code</a></span>
182
183 </td>
184 </tr>
185 </table>
186
187 </td>
188 </tr>
189 <tr>
190 <td colspan="2" class="summary">
191 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
192 <code>__delattr__</code>,
193 <code>__format__</code>,
194 <code>__getattribute__</code>,
195 <code>__hash__</code>,
196 <code>__new__</code>,
197 <code>__reduce__</code>,
198 <code>__reduce_ex__</code>,
199 <code>__repr__</code>,
200 <code>__setattr__</code>,
201 <code>__sizeof__</code>,
202 <code>__str__</code>,
203 <code>__subclasshook__</code>
204 </p>
205 </td>
206 </tr>
207</table>
208<!-- ==================== STATIC METHODS ==================== -->
209<a name="section-StaticMethods"></a>
210<table class="summary" border="1" cellpadding="3"
211 cellspacing="0" width="100%" bgcolor="white">
212<tr bgcolor="#70b0f0" class="table-header">
213 <td colspan="2" class="table-header">
214 <table border="0" cellpadding="0" cellspacing="0" width="100%">
215 <tr valign="top">
216 <td align="left"><span class="table-header">Static Methods</span></td>
217 <td align="right" valign="top"
218 ><span class="options">[<a href="#section-StaticMethods"
219 class="privatelink" onclick="toggle_private();"
220 >hide private</a>]</span></td>
221 </tr>
222 </table>
223 </td>
224</tr>
225<tr>
226 <td width="15%" align="right" valign="top" class="summary">
227 <span class="summary-type">&nbsp;</span>
228 </td><td class="summary">
229 <table width="100%" cellpadding="0" cellspacing="0" border="0">
230 <tr>
231 <td><span class="summary-sig"><a name="from_json"></a><span class="summary-sig-name">from_json</span>(<span class="summary-sig-arg">s</span>,
232 <span class="summary-sig-arg">http</span>,
233 <span class="summary-sig-arg">postproc</span>)</span><br />
234 Returns an HttpRequest populated with info from a JSON object.</td>
235 <td align="right" valign="top">
236 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.from_json">source&nbsp;code</a></span>
237
238 </td>
239 </tr>
240 </table>
241
242 </td>
243 </tr>
244</table>
245<!-- ==================== PROPERTIES ==================== -->
246<a name="section-Properties"></a>
247<table class="summary" border="1" cellpadding="3"
248 cellspacing="0" width="100%" bgcolor="white">
249<tr bgcolor="#70b0f0" class="table-header">
250 <td colspan="2" class="table-header">
251 <table border="0" cellpadding="0" cellspacing="0" width="100%">
252 <tr valign="top">
253 <td align="left"><span class="table-header">Properties</span></td>
254 <td align="right" valign="top"
255 ><span class="options">[<a href="#section-Properties"
256 class="privatelink" onclick="toggle_private();"
257 >hide private</a>]</span></td>
258 </tr>
259 </table>
260 </td>
261</tr>
262 <tr>
263 <td colspan="2" class="summary">
264 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
265 <code>__class__</code>
266 </p>
267 </td>
268 </tr>
269</table>
270<!-- ==================== METHOD DETAILS ==================== -->
271<a name="section-MethodDetails"></a>
272<table class="details" border="1" cellpadding="3"
273 cellspacing="0" width="100%" bgcolor="white">
274<tr bgcolor="#70b0f0" class="table-header">
275 <td colspan="2" class="table-header">
276 <table border="0" cellpadding="0" cellspacing="0" width="100%">
277 <tr valign="top">
278 <td align="left"><span class="table-header">Method Details</span></td>
279 <td align="right" valign="top"
280 ><span class="options">[<a href="#section-MethodDetails"
281 class="privatelink" onclick="toggle_private();"
282 >hide private</a>]</span></td>
283 </tr>
284 </table>
285 </td>
286</tr>
287</table>
288<a name="__init__"></a>
289<div>
290<table class="details" border="1" cellpadding="3"
291 cellspacing="0" width="100%" bgcolor="white">
292<tr><td>
293 <table width="100%" cellpadding="0" cellspacing="0" border="0">
294 <tr valign="top"><td>
295 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
296 <span class="sig-arg">http</span>,
297 <span class="sig-arg">postproc</span>,
298 <span class="sig-arg">uri</span>,
299 <span class="sig-arg">method</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">GET</code><code class="variable-quote">'</code></span>,
300 <span class="sig-arg">body</span>=<span class="sig-default">None</span>,
301 <span class="sig-arg">headers</span>=<span class="sig-default">None</span>,
302 <span class="sig-arg">methodId</span>=<span class="sig-default">None</span>,
303 <span class="sig-arg">resumable</span>=<span class="sig-default">None</span>)</span>
304 <br /><em class="fname">(Constructor)</em>
305 </h3>
306 </td><td align="right" valign="top"
307 ><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.__init__">source&nbsp;code</a></span>&nbsp;
308 </td>
309 </tr></table>
310
311 <pre class="literalblock">
312Constructor for an HttpRequest.
313
314Args:
315 http: httplib2.Http, the transport object to use to make a request
316 postproc: callable, called on the HTTP response and content to transform
317 it into a data object before returning, or raising an exception
318 on an error.
319 uri: string, the absolute URI to send the request to
320 method: string, the HTTP method to use
321 body: string, the request body of the HTTP request,
322 headers: dict, the HTTP request headers
323 methodId: string, a unique identifier for the API method being called.
324 resumable: MediaUpload, None if this is not a resumbale request.
325
326</pre>
327 <dl class="fields">
328 <dt>Overrides:
329 object.__init__
330 </dt>
331 </dl>
332</td></tr></table>
333</div>
334<a name="execute"></a>
335<div>
336<table class="details" border="1" cellpadding="3"
337 cellspacing="0" width="100%" bgcolor="white">
338<tr><td>
339 <table width="100%" cellpadding="0" cellspacing="0" border="0">
340 <tr valign="top"><td>
341 <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
342 <span class="sig-arg">http</span>=<span class="sig-default">None</span>)</span>
343 </h3>
344 </td><td align="right" valign="top"
345 ><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.execute">source&nbsp;code</a></span>&nbsp;
346 </td>
347 </tr></table>
348
349 <pre class="literalblock">
350Execute the request.
351
352Args:
353 http: httplib2.Http, an http object to be used in place of the
354 one the HttpRequest request object was constructed with.
355
356Returns:
357 A deserialized object model of the response body as determined
358 by the postproc.
359
360Raises:
361 apiclient.errors.HttpError if the response was not a 2xx.
362 httplib2.Error if a transport error has occured.
363
364</pre>
365 <dl class="fields">
366 </dl>
367</td></tr></table>
368</div>
369<a name="next_chunk"></a>
370<div>
371<table class="details" border="1" cellpadding="3"
372 cellspacing="0" width="100%" bgcolor="white">
373<tr><td>
374 <table width="100%" cellpadding="0" cellspacing="0" border="0">
375 <tr valign="top"><td>
376 <h3 class="epydoc"><span class="sig"><span class="sig-name">next_chunk</span>(<span class="sig-arg">self</span>,
377 <span class="sig-arg">http</span>=<span class="sig-default">None</span>)</span>
378 </h3>
379 </td><td align="right" valign="top"
380 ><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.next_chunk">source&nbsp;code</a></span>&nbsp;
381 </td>
382 </tr></table>
383
384 <pre class="literalblock">
385Execute the next step of a resumable upload.
386
387Can only be used if the method being executed supports media uploads and
388the MediaUpload object passed in was flagged as using resumable upload.
389
390Example:
391
392 media = MediaFileUpload('smiley.png', mimetype='image/png',
393 chunksize=1000, resumable=True)
394 request = service.objects().insert(
395 bucket=buckets['items'][0]['id'],
396 name='smiley.png',
397 media_body=media)
398
399 response = None
400 while response is None:
401 status, response = request.next_chunk()
402 if status:
403 print &quot;Upload %d%% complete.&quot; % int(status.progress() * 100)
404
405
406Returns:
407 (status, body): (ResumableMediaStatus, object)
408 The body will be None until the resumable media is fully uploaded.
409
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]410Raises:
411 apiclient.errors.HttpError if the response was not a 2xx.
412 httplib2.Error if a transport error has occured.
413
414</pre>
415 <dl class="fields">
416 </dl>
417</td></tr></table>
418</div>
419<a name="_process_response"></a>
420<div class="private">
421<table class="details" border="1" cellpadding="3"
422 cellspacing="0" width="100%" bgcolor="white">
423<tr><td>
424 <table width="100%" cellpadding="0" cellspacing="0" border="0">
425 <tr valign="top"><td>
426 <h3 class="epydoc"><span class="sig"><span class="sig-name">_process_response</span>(<span class="sig-arg">self</span>,
427 <span class="sig-arg">resp</span>,
428 <span class="sig-arg">content</span>)</span>
429 </h3>
430 </td><td align="right" valign="top"
431 ><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest._process_response">source&nbsp;code</a></span>&nbsp;
432 </td>
433 </tr></table>
434
435 <pre class="literalblock">
436Process the response from a single chunk upload.
437
438Args:
439 resp: httplib2.Response, the response object.
440 content: string, the content of the response.
441
442Returns:
443 (status, body): (ResumableMediaStatus, object)
444 The body will be None until the resumable media is fully uploaded.
445
446Raises:
447 apiclient.errors.HttpError if the response was not a 2xx or a 308.
448
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]449</pre>
450 <dl class="fields">
451 </dl>
452</td></tr></table>
453</div>
454<br />
455<!-- ==================== NAVIGATION BAR ==================== -->
456<table class="navbar" border="0" width="100%" cellpadding="0"
457 bgcolor="#a0c0ff" cellspacing="0">
458 <tr valign="middle">
459
460 <!-- Tree link -->
461 <th>&nbsp;&nbsp;&nbsp;<a
462 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
463
464 <!-- Index link -->
465 <th>&nbsp;&nbsp;&nbsp;<a
466 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
467
468 <!-- Help link -->
469 <th>&nbsp;&nbsp;&nbsp;<a
470 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
471
472 <th class="navbar" width="100%"></th>
473 </tr>
474</table>
475<table border="0" cellpadding="0" cellspacing="0" width="100%%">
476 <tr>
477 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]478 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]479 </td>
480 <td align="right" class="footer">
481 <a target="mainFrame" href="http://epydoc.sourceforge.net"
482 >http://epydoc.sourceforge.net</a>
483 </td>
484 </tr>
485</table>
486
487<script type="text/javascript">
488 <!--
489 // Private objects are initially displayed (because if
490 // javascript is turned off then we want them to be
491 // visible); but by default, we want to hide them. So hide
492 // them unless we have a cookie that says to show them.
493 checkCookie();
494 // -->
495</script>
496</body>
497</html>