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