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