Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c29aaa9f8e5155f7a948c149fd2fec14e93f588c / . / docs / epy / apiclient.http-module.html
blob: c40b0c4ad78487ffa6024a3b4b093fc45a3916a2 [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">
114 <a href="apiclient.http.MediaFileUpload-class.html" class="summary-name">MediaFileUpload</a><br />
115 A MediaUpload for a file.
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 Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]122 <a href="apiclient.http.MediaIoBaseUpload-class.html" class="summary-name">MediaIoBaseUpload</a><br />
123 A MediaUpload for a io.Base objects.
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>
142<tr>
143 <td width="15%" align="right" valign="top" class="summary">
144 <span class="summary-type">&nbsp;</span>
145 </td><td class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]146 <a href="apiclient.http.HttpRequest-class.html" class="summary-name">HttpRequest</a><br />
147 Encapsulates a single HTTP request.
148 </td>
149 </tr>
150<tr>
151 <td width="15%" align="right" valign="top" class="summary">
152 <span class="summary-type">&nbsp;</span>
153 </td><td class="summary">
154 <a href="apiclient.http.BatchHttpRequest-class.html" class="summary-name">BatchHttpRequest</a><br />
155 Batches multiple HttpRequest objects into 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.HttpRequestMock-class.html" class="summary-name">HttpRequestMock</a><br />
163 Mock of HttpRequest.
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.RequestMockBuilder-class.html" class="summary-name">RequestMockBuilder</a><br />
171 A simple 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.HttpMock-class.html" class="summary-name">HttpMock</a><br />
179 Mock of httplib2.Http
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.HttpMockSequence-class.html" class="summary-name">HttpMockSequence</a><br />
187 Mock of httplib2.Http
188 </td>
189 </tr>
190</table>
191<!-- ==================== FUNCTIONS ==================== -->
192<a name="section-Functions"></a>
193<table class="summary" border="1" cellpadding="3"
194 cellspacing="0" width="100%" bgcolor="white">
195<tr bgcolor="#70b0f0" class="table-header">
196 <td colspan="2" class="table-header">
197 <table border="0" cellpadding="0" cellspacing="0" width="100%">
198 <tr valign="top">
199 <td align="left"><span class="table-header">Functions</span></td>
200 <td align="right" valign="top"
201 ><span class="options">[<a href="#section-Functions"
202 class="privatelink" onclick="toggle_private();"
203 >hide private</a>]</span></td>
204 </tr>
205 </table>
206 </td>
207</tr>
208<tr>
209 <td width="15%" align="right" valign="top" class="summary">
210 <span class="summary-type">&nbsp;</span>
211 </td><td class="summary">
212 <table width="100%" cellpadding="0" cellspacing="0" border="0">
213 <tr>
214 <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>,
215 <span class="summary-sig-arg">user_agent</span>)</span><br />
216 Set the user-agent on every request.</td>
217 <td align="right" valign="top">
218 <span class="codelink"><a href="apiclient.http-pysrc.html#set_user_agent">source&nbsp;code</a></span>
219
220 </td>
221 </tr>
222 </table>
223
224 </td>
225 </tr>
226<tr>
227 <td width="15%" align="right" valign="top" class="summary">
228 <span class="summary-type">&nbsp;</span>
229 </td><td class="summary">
230 <table width="100%" cellpadding="0" cellspacing="0" border="0">
231 <tr>
232 <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 />
233 Tunnel PATCH requests over POST.</td>
234 <td align="right" valign="top">
235 <span class="codelink"><a href="apiclient.http-pysrc.html#tunnel_patch">source&nbsp;code</a></span>
236
237 </td>
238 </tr>
239 </table>
240
241 </td>
242 </tr>
243</table>
244<!-- ==================== VARIABLES ==================== -->
245<a name="section-Variables"></a>
246<table class="summary" border="1" cellpadding="3"
247 cellspacing="0" width="100%" bgcolor="white">
248<tr bgcolor="#70b0f0" class="table-header">
249 <td colspan="2" class="table-header">
250 <table border="0" cellpadding="0" cellspacing="0" width="100%">
251 <tr valign="top">
252 <td align="left"><span class="table-header">Variables</span></td>
253 <td align="right" valign="top"
254 ><span class="options">[<a href="#section-Variables"
255 class="privatelink" onclick="toggle_private();"
256 >hide private</a>]</span></td>
257 </tr>
258 </table>
259 </td>
260</tr>
261<tr>
262 <td width="15%" align="right" valign="top" class="summary">
263 <span class="summary-type">&nbsp;</span>
264 </td><td class="summary">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]265 <a name="DEFAULT_CHUNK_SIZE"></a><span class="summary-name">DEFAULT_CHUNK_SIZE</span> = <code title="524288">524288</code>
266 </td>
267 </tr>
268<tr>
269 <td width="15%" align="right" valign="top" class="summary">
270 <span class="summary-type">&nbsp;</span>
271 </td><td class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]272 <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>
273 </td>
274 </tr>
275</table>
276<!-- ==================== FUNCTION DETAILS ==================== -->
277<a name="section-FunctionDetails"></a>
278<table class="details" border="1" cellpadding="3"
279 cellspacing="0" width="100%" bgcolor="white">
280<tr bgcolor="#70b0f0" class="table-header">
281 <td colspan="2" class="table-header">
282 <table border="0" cellpadding="0" cellspacing="0" width="100%">
283 <tr valign="top">
284 <td align="left"><span class="table-header">Function Details</span></td>
285 <td align="right" valign="top"
286 ><span class="options">[<a href="#section-FunctionDetails"
287 class="privatelink" onclick="toggle_private();"
288 >hide private</a>]</span></td>
289 </tr>
290 </table>
291 </td>
292</tr>
293</table>
294<a name="set_user_agent"></a>
295<div>
296<table class="details" border="1" cellpadding="3"
297 cellspacing="0" width="100%" bgcolor="white">
298<tr><td>
299 <table width="100%" cellpadding="0" cellspacing="0" border="0">
300 <tr valign="top"><td>
301 <h3 class="epydoc"><span class="sig"><span class="sig-name">set_user_agent</span>(<span class="sig-arg">http</span>,
302 <span class="sig-arg">user_agent</span>)</span>
303 </h3>
304 </td><td align="right" valign="top"
305 ><span class="codelink"><a href="apiclient.http-pysrc.html#set_user_agent">source&nbsp;code</a></span>&nbsp;
306 </td>
307 </tr></table>
308
309 <pre class="literalblock">
310Set the user-agent on every request.
311
312Args:
313 http - An instance of httplib2.Http
314 or something that acts like it.
315 user_agent: string, the value for the user-agent header.
316
317Returns:
318 A modified instance of http that was passed in.
319
320Example:
321
322 h = httplib2.Http()
323 h = set_user_agent(h, &quot;my-app-name/6.0&quot;)
324
325Most of the time the user-agent will be set doing auth, this is for the rare
326cases where you are accessing an unauthenticated endpoint.
327
328</pre>
329 <dl class="fields">
330 </dl>
331</td></tr></table>
332</div>
333<a name="tunnel_patch"></a>
334<div>
335<table class="details" border="1" cellpadding="3"
336 cellspacing="0" width="100%" bgcolor="white">
337<tr><td>
338 <table width="100%" cellpadding="0" cellspacing="0" border="0">
339 <tr valign="top"><td>
340 <h3 class="epydoc"><span class="sig"><span class="sig-name">tunnel_patch</span>(<span class="sig-arg">http</span>)</span>
341 </h3>
342 </td><td align="right" valign="top"
343 ><span class="codelink"><a href="apiclient.http-pysrc.html#tunnel_patch">source&nbsp;code</a></span>&nbsp;
344 </td>
345 </tr></table>
346
347 <pre class="literalblock">
348Tunnel PATCH requests over POST.
349Args:
350 http - An instance of httplib2.Http
351 or something that acts like it.
352
353Returns:
354 A modified instance of http that was passed in.
355
356Example:
357
358 h = httplib2.Http()
359 h = tunnel_patch(h, &quot;my-app-name/6.0&quot;)
360
361Useful if you are running on a platform that doesn't support PATCH.
362Apply this last if you are using OAuth 1.0, as changing the method
363will result in a different signature.
364
365</pre>
366 <dl class="fields">
367 </dl>
368</td></tr></table>
369</div>
370<br />
371<!-- ==================== NAVIGATION BAR ==================== -->
372<table class="navbar" border="0" width="100%" cellpadding="0"
373 bgcolor="#a0c0ff" cellspacing="0">
374 <tr valign="middle">
375
376 <!-- Tree link -->
377 <th>&nbsp;&nbsp;&nbsp;<a
378 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
379
380 <!-- Index link -->
381 <th>&nbsp;&nbsp;&nbsp;<a
382 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
383
384 <!-- Help link -->
385 <th>&nbsp;&nbsp;&nbsp;<a
386 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
387
388 <th class="navbar" width="100%"></th>
389 </tr>
390</table>
391<table border="0" cellpadding="0" cellspacing="0" width="100%%">
392 <tr>
393 <td align="left" class="footer">
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]394 Generated by Epydoc 3.0.1 on Thu Jul 12 10:44:08 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]395 </td>
396 <td align="right" class="footer">
397 <a target="mainFrame" href="http://epydoc.sourceforge.net"
398 >http://epydoc.sourceforge.net</a>
399 </td>
400 </tr>
401</table>
402
403<script type="text/javascript">
404 <!--
405 // Private objects are initially displayed (because if
406 // javascript is turned off then we want them to be
407 // visible); but by default, we want to hide them. So hide
408 // them unless we have a cookie that says to show them.
409 checkCookie();
410 // -->
411</script>
412</body>
413</html>