Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / epy / googleapiclient.http-module.html
blob: b66a031ba711c0b51e0249093f3f5f147ae2228f [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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>googleapiclient.http</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 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="googleapiclient-module.html">Package&nbsp;googleapiclient</a> ::
41 Module&nbsp;http
42 </span>
43 </td>
44 <td>
45 <table cellpadding="0" cellspacing="0">
46 <!-- hide/show private -->
47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
48 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
49 <tr><td align="right"><span class="options"
50 >[<a href="frames.html" target="_top">frames</a
51 >]&nbsp;|&nbsp;<a href="googleapiclient.http-module.html"
52 target="_top">no&nbsp;frames</a>]</span></td></tr>
53 </table>
54 </td>
55 </tr>
56</table>
57<!-- ==================== MODULE DESCRIPTION ==================== -->
58<h1 class="epydoc">Module http</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html">source&nbsp;code</a></span></p>
59<pre class="literalblock">
60Classes to encapsulate a single HTTP request.
61
62The classes implement a command pattern, with every
63object supporting an execute() method that does the
64actuall HTTP request.
65
66</pre>
67
68<hr />
69<div class="fields"> <p><strong>Author:</strong>
70 jcgregorio@google.com (Joe Gregorio)
71 </p>
72</div><!-- ==================== CLASSES ==================== -->
73<a name="section-Classes"></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">Classes</span></td>
81 <td align="right" valign="top"
82 ><span class="options">[<a href="#section-Classes"
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 <a href="googleapiclient.http.MediaUploadProgress-class.html" class="summary-name">MediaUploadProgress</a><br />
94 Status of a resumable upload.
95 </td>
96 </tr>
97<tr>
98 <td width="15%" align="right" valign="top" class="summary">
99 <span class="summary-type">&nbsp;</span>
100 </td><td class="summary">
101 <a href="googleapiclient.http.MediaDownloadProgress-class.html" class="summary-name">MediaDownloadProgress</a><br />
102 Status of a resumable download.
103 </td>
104 </tr>
105<tr>
106 <td width="15%" align="right" valign="top" class="summary">
107 <span class="summary-type">&nbsp;</span>
108 </td><td class="summary">
109 <a href="googleapiclient.http.MediaUpload-class.html" class="summary-name">MediaUpload</a><br />
110 Describes a media object to upload.
111 </td>
112 </tr>
113<tr>
114 <td width="15%" align="right" valign="top" class="summary">
115 <span class="summary-type">&nbsp;</span>
116 </td><td class="summary">
117 <a href="googleapiclient.http.MediaIoBaseUpload-class.html" class="summary-name">MediaIoBaseUpload</a><br />
118 A MediaUpload for a io.Base objects.
119 </td>
120 </tr>
121<tr>
122 <td width="15%" align="right" valign="top" class="summary">
123 <span class="summary-type">&nbsp;</span>
124 </td><td class="summary">
125 <a href="googleapiclient.http.MediaFileUpload-class.html" class="summary-name">MediaFileUpload</a><br />
126 A MediaUpload for a file.
127 </td>
128 </tr>
129<tr>
130 <td width="15%" align="right" valign="top" class="summary">
131 <span class="summary-type">&nbsp;</span>
132 </td><td class="summary">
133 <a href="googleapiclient.http.MediaInMemoryUpload-class.html" class="summary-name">MediaInMemoryUpload</a><br />
134 MediaUpload for a chunk of bytes.
135 </td>
136 </tr>
137<tr>
138 <td width="15%" align="right" valign="top" class="summary">
139 <span class="summary-type">&nbsp;</span>
140 </td><td class="summary">
141 <a href="googleapiclient.http.MediaIoBaseDownload-class.html" class="summary-name">MediaIoBaseDownload</a><br />
142 &quot;Download media resources.
143 </td>
144 </tr>
145<tr class="private">
146 <td width="15%" align="right" valign="top" class="summary">
147 <span class="summary-type">&nbsp;</span>
148 </td><td class="summary">
149 <a href="googleapiclient.http._StreamSlice-class.html" class="summary-name" onclick="show_private();">_StreamSlice</a><br />
150 Truncated stream.
151 </td>
152 </tr>
153<tr>
154 <td width="15%" align="right" valign="top" class="summary">
155 <span class="summary-type">&nbsp;</span>
156 </td><td class="summary">
157 <a href="googleapiclient.http.HttpRequest-class.html" class="summary-name">HttpRequest</a><br />
158 Encapsulates a single HTTP request.
159 </td>
160 </tr>
161<tr>
162 <td width="15%" align="right" valign="top" class="summary">
163 <span class="summary-type">&nbsp;</span>
164 </td><td class="summary">
165 <a href="googleapiclient.http.BatchHttpRequest-class.html" class="summary-name">BatchHttpRequest</a><br />
166 Batches multiple HttpRequest objects into a single HTTP request.
167 </td>
168 </tr>
169<tr>
170 <td width="15%" align="right" valign="top" class="summary">
171 <span class="summary-type">&nbsp;</span>
172 </td><td class="summary">
173 <a href="googleapiclient.http.HttpRequestMock-class.html" class="summary-name">HttpRequestMock</a><br />
174 Mock of HttpRequest.
175 </td>
176 </tr>
177<tr>
178 <td width="15%" align="right" valign="top" class="summary">
179 <span class="summary-type">&nbsp;</span>
180 </td><td class="summary">
181 <a href="googleapiclient.http.RequestMockBuilder-class.html" class="summary-name">RequestMockBuilder</a><br />
182 A simple mock of HttpRequest
183 </td>
184 </tr>
185<tr>
186 <td width="15%" align="right" valign="top" class="summary">
187 <span class="summary-type">&nbsp;</span>
188 </td><td class="summary">
189 <a href="googleapiclient.http.HttpMock-class.html" class="summary-name">HttpMock</a><br />
190 Mock of httplib2.Http
191 </td>
192 </tr>
193<tr>
194 <td width="15%" align="right" valign="top" class="summary">
195 <span class="summary-type">&nbsp;</span>
196 </td><td class="summary">
197 <a href="googleapiclient.http.HttpMockSequence-class.html" class="summary-name">HttpMockSequence</a><br />
198 Mock of httplib2.Http
199 </td>
200 </tr>
201</table>
202<!-- ==================== FUNCTIONS ==================== -->
203<a name="section-Functions"></a>
204<table class="summary" border="1" cellpadding="3"
205 cellspacing="0" width="100%" bgcolor="white">
206<tr bgcolor="#70b0f0" class="table-header">
207 <td colspan="2" class="table-header">
208 <table border="0" cellpadding="0" cellspacing="0" width="100%">
209 <tr valign="top">
210 <td align="left"><span class="table-header">Functions</span></td>
211 <td align="right" valign="top"
212 ><span class="options">[<a href="#section-Functions"
213 class="privatelink" onclick="toggle_private();"
214 >hide private</a>]</span></td>
215 </tr>
216 </table>
217 </td>
218</tr>
219<tr>
220 <td width="15%" align="right" valign="top" class="summary">
221 <span class="summary-type">&nbsp;</span>
222 </td><td class="summary">
223 <table width="100%" cellpadding="0" cellspacing="0" border="0">
224 <tr>
225 <td><span class="summary-sig"><a href="googleapiclient.http-module.html#set_user_agent" class="summary-sig-name">set_user_agent</a>(<span class="summary-sig-arg">http</span>,
226 <span class="summary-sig-arg">user_agent</span>)</span><br />
227 Set the user-agent on every request.</td>
228 <td align="right" valign="top">
229 <span class="codelink"><a href="googleapiclient.http-pysrc.html#set_user_agent">source&nbsp;code</a></span>
230
231 </td>
232 </tr>
233 </table>
234
235 </td>
236 </tr>
237<tr>
238 <td width="15%" align="right" valign="top" class="summary">
239 <span class="summary-type">&nbsp;</span>
240 </td><td class="summary">
241 <table width="100%" cellpadding="0" cellspacing="0" border="0">
242 <tr>
243 <td><span class="summary-sig"><a href="googleapiclient.http-module.html#tunnel_patch" class="summary-sig-name">tunnel_patch</a>(<span class="summary-sig-arg">http</span>)</span><br />
244 Tunnel PATCH requests over POST.</td>
245 <td align="right" valign="top">
246 <span class="codelink"><a href="googleapiclient.http-pysrc.html#tunnel_patch">source&nbsp;code</a></span>
247
248 </td>
249 </tr>
250 </table>
251
252 </td>
253 </tr>
254</table>
255<!-- ==================== VARIABLES ==================== -->
256<a name="section-Variables"></a>
257<table class="summary" border="1" cellpadding="3"
258 cellspacing="0" width="100%" bgcolor="white">
259<tr bgcolor="#70b0f0" class="table-header">
260 <td colspan="2" class="table-header">
261 <table border="0" cellpadding="0" cellspacing="0" width="100%">
262 <tr valign="top">
263 <td align="left"><span class="table-header">Variables</span></td>
264 <td align="right" valign="top"
265 ><span class="options">[<a href="#section-Variables"
266 class="privatelink" onclick="toggle_private();"
267 >hide private</a>]</span></td>
268 </tr>
269 </table>
270 </td>
271</tr>
272<tr>
273 <td width="15%" align="right" valign="top" class="summary">
274 <span class="summary-type">&nbsp;</span>
275 </td><td class="summary">
276 <a name="DEFAULT_CHUNK_SIZE"></a><span class="summary-name">DEFAULT_CHUNK_SIZE</span> = <code title="512* 1024">512* 1024</code>
277 </td>
278 </tr>
279<tr>
280 <td width="15%" align="right" valign="top" class="summary">
281 <span class="summary-type">&nbsp;</span>
282 </td><td class="summary">
283 <a name="MAX_URI_LENGTH"></a><span class="summary-name">MAX_URI_LENGTH</span> = <code title="2048">2048</code>
284 </td>
285 </tr>
286</table>
287<!-- ==================== FUNCTION DETAILS ==================== -->
288<a name="section-FunctionDetails"></a>
289<table class="details" border="1" cellpadding="3"
290 cellspacing="0" width="100%" bgcolor="white">
291<tr bgcolor="#70b0f0" class="table-header">
292 <td colspan="2" class="table-header">
293 <table border="0" cellpadding="0" cellspacing="0" width="100%">
294 <tr valign="top">
295 <td align="left"><span class="table-header">Function Details</span></td>
296 <td align="right" valign="top"
297 ><span class="options">[<a href="#section-FunctionDetails"
298 class="privatelink" onclick="toggle_private();"
299 >hide private</a>]</span></td>
300 </tr>
301 </table>
302 </td>
303</tr>
304</table>
305<a name="set_user_agent"></a>
306<div>
307<table class="details" border="1" cellpadding="3"
308 cellspacing="0" width="100%" bgcolor="white">
309<tr><td>
310 <table width="100%" cellpadding="0" cellspacing="0" border="0">
311 <tr valign="top"><td>
312 <h3 class="epydoc"><span class="sig"><span class="sig-name">set_user_agent</span>(<span class="sig-arg">http</span>,
313 <span class="sig-arg">user_agent</span>)</span>
314 </h3>
315 </td><td align="right" valign="top"
316 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#set_user_agent">source&nbsp;code</a></span>&nbsp;
317 </td>
318 </tr></table>
319
320 <pre class="literalblock">
321Set the user-agent on every request.
322
323Args:
324 http - An instance of httplib2.Http
325 or something that acts like it.
326 user_agent: string, the value for the user-agent header.
327
328Returns:
329 A modified instance of http that was passed in.
330
331Example:
332
333 h = httplib2.Http()
334 h = set_user_agent(h, &quot;my-app-name/6.0&quot;)
335
336Most of the time the user-agent will be set doing auth, this is for the rare
337cases where you are accessing an unauthenticated endpoint.
338
339</pre>
340 <dl class="fields">
341 </dl>
342</td></tr></table>
343</div>
344<a name="tunnel_patch"></a>
345<div>
346<table class="details" border="1" cellpadding="3"
347 cellspacing="0" width="100%" bgcolor="white">
348<tr><td>
349 <table width="100%" cellpadding="0" cellspacing="0" border="0">
350 <tr valign="top"><td>
351 <h3 class="epydoc"><span class="sig"><span class="sig-name">tunnel_patch</span>(<span class="sig-arg">http</span>)</span>
352 </h3>
353 </td><td align="right" valign="top"
354 ><span class="codelink"><a href="googleapiclient.http-pysrc.html#tunnel_patch">source&nbsp;code</a></span>&nbsp;
355 </td>
356 </tr></table>
357
358 <pre class="literalblock">
359Tunnel PATCH requests over POST.
360Args:
361 http - An instance of httplib2.Http
362 or something that acts like it.
363
364Returns:
365 A modified instance of http that was passed in.
366
367Example:
368
369 h = httplib2.Http()
370 h = tunnel_patch(h, &quot;my-app-name/6.0&quot;)
371
372Useful if you are running on a platform that doesn't support PATCH.
373Apply this last if you are using OAuth 1.0, as changing the method
374will result in a different signature.
375
376</pre>
377 <dl class="fields">
378 </dl>
379</td></tr></table>
380</div>
381<br />
382<!-- ==================== NAVIGATION BAR ==================== -->
383<table class="navbar" border="0" width="100%" cellpadding="0"
384 bgcolor="#a0c0ff" cellspacing="0">
385 <tr valign="middle">
386 <!-- Home link -->
387 <th>&nbsp;&nbsp;&nbsp;<a
388 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
389
390 <!-- Tree link -->
391 <th>&nbsp;&nbsp;&nbsp;<a
392 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
393
394 <!-- Index link -->
395 <th>&nbsp;&nbsp;&nbsp;<a
396 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
397
398 <!-- Help link -->
399 <th>&nbsp;&nbsp;&nbsp;<a
400 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
401
402 <th class="navbar" width="100%"></th>
403 </tr>
404</table>
405<table border="0" cellpadding="0" cellspacing="0" width="100%%">
406 <tr>
407 <td align="left" class="footer">
408 Generated by Epydoc 3.0.1 on Thu Apr 24 15:46:09 2014
409 </td>
410 <td align="right" class="footer">
411 <a target="mainFrame" href="http://epydoc.sourceforge.net"
412 >http://epydoc.sourceforge.net</a>
413 </td>
414 </tr>
415</table>
416
417<script type="text/javascript">
418 <!--
419 // Private objects are initially displayed (because if
420 // javascript is turned off then we want them to be
421 // visible); but by default, we want to hide them. So hide
422 // them unless we have a cookie that says to show them.
423 checkCookie();
424 // -->
425</script>
426</body>
427</html>