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