Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 66212035140c8f3abfb6ed14a40db27dbef4d220 / . / docs / epy / apiclient.http.BatchHttpRequest-class.html
blob: acd719fa8133b42c6196e55bcbdd61d225530163 [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.BatchHttpRequest</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 <a href="apiclient.http-module.html">Module&nbsp;http</a> ::
39 Class&nbsp;BatchHttpRequest
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="apiclient.http.BatchHttpRequest-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class BatchHttpRequest</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="uml_class_diagram_for_apiclien_12" name="uml_class_diagram_for_apiclien_12">
59<area shape="rect" href="apiclient.http.BatchHttpRequest-class.html#__init__" title="Constructor for a BatchHttpRequest." alt="" coords="17,36,324,55"/>
60<area shape="rect" href="apiclient.http.BatchHttpRequest-class.html#add" title="Add a new request." alt="" coords="17,55,324,73"/>
61<area shape="rect" href="apiclient.http.BatchHttpRequest-class.html#execute" title="Execute all the requests as a single batched HTTP request." alt="" coords="17,73,324,92"/>
62<area shape="rect" href="apiclient.http.BatchHttpRequest-class.html" title="Batches multiple HttpRequest objects into a single HTTP request." alt="" coords="16,11,325,93"/>
63</map>
64 <img src="uml_class_diagram_for_apiclien_12.gif" alt='' usemap="#uml_class_diagram_for_apiclien_12" ismap="ismap" class="graph-without-title" />
65</center>
66</center>
67<hr />
68<pre class="literalblock">
69Batches multiple HttpRequest objects into a single HTTP request.
70
71</pre>
72
73<!-- ==================== INSTANCE METHODS ==================== -->
74<a name="section-InstanceMethods"></a>
75<table class="summary" border="1" cellpadding="3"
76 cellspacing="0" width="100%" bgcolor="white">
77<tr bgcolor="#70b0f0" class="table-header">
78 <td colspan="2" class="table-header">
79 <table border="0" cellpadding="0" cellspacing="0" width="100%">
80 <tr valign="top">
81 <td align="left"><span class="table-header">Instance Methods</span></td>
82 <td align="right" valign="top"
83 ><span class="options">[<a href="#section-InstanceMethods"
84 class="privatelink" onclick="toggle_private();"
85 >hide private</a>]</span></td>
86 </tr>
87 </table>
88 </td>
89</tr>
90<tr>
91 <td width="15%" align="right" valign="top" class="summary">
92 <span class="summary-type">&nbsp;</span>
93 </td><td class="summary">
94 <table width="100%" cellpadding="0" cellspacing="0" border="0">
95 <tr>
96 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
97 <span class="summary-sig-arg">callback</span>=<span class="summary-sig-default">None</span>,
98 <span class="summary-sig-arg">batch_uri</span>=<span class="summary-sig-default">None</span>)</span><br />
99 Constructor for a BatchHttpRequest.</td>
100 <td align="right" valign="top">
101 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.__init__">source&nbsp;code</a></span>
102
103 </td>
104 </tr>
105 </table>
106
107 </td>
108 </tr>
109<tr class="private">
110 <td width="15%" align="right" valign="top" class="summary">
111 <span class="summary-type">&nbsp;</span>
112 </td><td class="summary">
113 <table width="100%" cellpadding="0" cellspacing="0" border="0">
114 <tr>
115 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#_refresh_and_apply_credentials" class="summary-sig-name" onclick="show_private();">_refresh_and_apply_credentials</a>(<span class="summary-sig-arg">self</span>,
116 <span class="summary-sig-arg">request</span>,
117 <span class="summary-sig-arg">http</span>)</span><br />
118 Refresh the credentials and apply to the request.</td>
119 <td align="right" valign="top">
120 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._refresh_and_apply_credentials">source&nbsp;code</a></span>
121
122 </td>
123 </tr>
124 </table>
125
126 </td>
127 </tr>
128<tr class="private">
129 <td width="15%" align="right" valign="top" class="summary">
130 <span class="summary-type">&nbsp;</span>
131 </td><td class="summary">
132 <table width="100%" cellpadding="0" cellspacing="0" border="0">
133 <tr>
134 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#_id_to_header" class="summary-sig-name" onclick="show_private();">_id_to_header</a>(<span class="summary-sig-arg">self</span>,
135 <span class="summary-sig-arg">id_</span>)</span><br />
136 Convert an id to a Content-ID header value.</td>
137 <td align="right" valign="top">
138 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._id_to_header">source&nbsp;code</a></span>
139
140 </td>
141 </tr>
142 </table>
143
144 </td>
145 </tr>
146<tr class="private">
147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type">&nbsp;</span>
149 </td><td class="summary">
150 <table width="100%" cellpadding="0" cellspacing="0" border="0">
151 <tr>
152 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#_header_to_id" class="summary-sig-name" onclick="show_private();">_header_to_id</a>(<span class="summary-sig-arg">self</span>,
153 <span class="summary-sig-arg">header</span>)</span><br />
154 Convert a Content-ID header value to an id.</td>
155 <td align="right" valign="top">
156 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._header_to_id">source&nbsp;code</a></span>
157
158 </td>
159 </tr>
160 </table>
161
162 </td>
163 </tr>
164<tr class="private">
165 <td width="15%" align="right" valign="top" class="summary">
166 <span class="summary-type">&nbsp;</span>
167 </td><td class="summary">
168 <table width="100%" cellpadding="0" cellspacing="0" border="0">
169 <tr>
170 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#_serialize_request" class="summary-sig-name" onclick="show_private();">_serialize_request</a>(<span class="summary-sig-arg">self</span>,
171 <span class="summary-sig-arg">request</span>)</span><br />
172 Convert an HttpRequest object into a string.</td>
173 <td align="right" valign="top">
174 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._serialize_request">source&nbsp;code</a></span>
175
176 </td>
177 </tr>
178 </table>
179
180 </td>
181 </tr>
182<tr class="private">
183 <td width="15%" align="right" valign="top" class="summary">
184 <span class="summary-type">&nbsp;</span>
185 </td><td class="summary">
186 <table width="100%" cellpadding="0" cellspacing="0" border="0">
187 <tr>
188 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#_deserialize_response" class="summary-sig-name" onclick="show_private();">_deserialize_response</a>(<span class="summary-sig-arg">self</span>,
189 <span class="summary-sig-arg">payload</span>)</span><br />
190 Convert string into httplib2 response and content.</td>
191 <td align="right" valign="top">
192 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._deserialize_response">source&nbsp;code</a></span>
193
194 </td>
195 </tr>
196 </table>
197
198 </td>
199 </tr>
200<tr class="private">
201 <td width="15%" align="right" valign="top" class="summary">
202 <span class="summary-type">&nbsp;</span>
203 </td><td class="summary">
204 <table width="100%" cellpadding="0" cellspacing="0" border="0">
205 <tr>
206 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#_new_id" class="summary-sig-name" onclick="show_private();">_new_id</a>(<span class="summary-sig-arg">self</span>)</span><br />
207 Create a new id.</td>
208 <td align="right" valign="top">
209 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._new_id">source&nbsp;code</a></span>
210
211 </td>
212 </tr>
213 </table>
214
215 </td>
216 </tr>
217<tr>
218 <td width="15%" align="right" valign="top" class="summary">
219 <span class="summary-type">&nbsp;</span>
220 </td><td class="summary">
221 <table width="100%" cellpadding="0" cellspacing="0" border="0">
222 <tr>
223 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>,
224 <span class="summary-sig-arg">request</span>,
225 <span class="summary-sig-arg">callback</span>=<span class="summary-sig-default">None</span>,
226 <span class="summary-sig-arg">request_id</span>=<span class="summary-sig-default">None</span>)</span><br />
227 Add a new request.</td>
228 <td align="right" valign="top">
229 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.add">source&nbsp;code</a></span>
230
231 </td>
232 </tr>
233 </table>
234
235 </td>
236 </tr>
237<tr class="private">
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="apiclient.http.BatchHttpRequest-class.html#_execute" class="summary-sig-name" onclick="show_private();">_execute</a>(<span class="summary-sig-arg">self</span>,
244 <span class="summary-sig-arg">http</span>,
245 <span class="summary-sig-arg">order</span>,
246 <span class="summary-sig-arg">requests</span>)</span><br />
247 Serialize batch request, send to server, process response.</td>
248 <td align="right" valign="top">
249 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._execute">source&nbsp;code</a></span>
250
251 </td>
252 </tr>
253 </table>
254
255 </td>
256 </tr>
257<tr>
258 <td width="15%" align="right" valign="top" class="summary">
259 <span class="summary-type">&nbsp;</span>
260 </td><td class="summary">
261 <table width="100%" cellpadding="0" cellspacing="0" border="0">
262 <tr>
263 <td><span class="summary-sig"><a href="apiclient.http.BatchHttpRequest-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
264 <span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>)</span><br />
265 Execute all the requests as a single batched HTTP request.</td>
266 <td align="right" valign="top">
267 <span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.execute">source&nbsp;code</a></span>
268
269 </td>
270 </tr>
271 </table>
272
273 </td>
274 </tr>
275 <tr>
276 <td colspan="2" class="summary">
277 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
278 <code>__delattr__</code>,
279 <code>__format__</code>,
280 <code>__getattribute__</code>,
281 <code>__hash__</code>,
282 <code>__new__</code>,
283 <code>__reduce__</code>,
284 <code>__reduce_ex__</code>,
285 <code>__repr__</code>,
286 <code>__setattr__</code>,
287 <code>__sizeof__</code>,
288 <code>__str__</code>,
289 <code>__subclasshook__</code>
290 </p>
291 </td>
292 </tr>
293</table>
294<!-- ==================== PROPERTIES ==================== -->
295<a name="section-Properties"></a>
296<table class="summary" border="1" cellpadding="3"
297 cellspacing="0" width="100%" bgcolor="white">
298<tr bgcolor="#70b0f0" class="table-header">
299 <td colspan="2" class="table-header">
300 <table border="0" cellpadding="0" cellspacing="0" width="100%">
301 <tr valign="top">
302 <td align="left"><span class="table-header">Properties</span></td>
303 <td align="right" valign="top"
304 ><span class="options">[<a href="#section-Properties"
305 class="privatelink" onclick="toggle_private();"
306 >hide private</a>]</span></td>
307 </tr>
308 </table>
309 </td>
310</tr>
311 <tr>
312 <td colspan="2" class="summary">
313 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
314 <code>__class__</code>
315 </p>
316 </td>
317 </tr>
318</table>
319<!-- ==================== METHOD DETAILS ==================== -->
320<a name="section-MethodDetails"></a>
321<table class="details" border="1" cellpadding="3"
322 cellspacing="0" width="100%" bgcolor="white">
323<tr bgcolor="#70b0f0" class="table-header">
324 <td colspan="2" class="table-header">
325 <table border="0" cellpadding="0" cellspacing="0" width="100%">
326 <tr valign="top">
327 <td align="left"><span class="table-header">Method Details</span></td>
328 <td align="right" valign="top"
329 ><span class="options">[<a href="#section-MethodDetails"
330 class="privatelink" onclick="toggle_private();"
331 >hide private</a>]</span></td>
332 </tr>
333 </table>
334 </td>
335</tr>
336</table>
337<a name="__init__"></a>
338<div>
339<table class="details" border="1" cellpadding="3"
340 cellspacing="0" width="100%" bgcolor="white">
341<tr><td>
342 <table width="100%" cellpadding="0" cellspacing="0" border="0">
343 <tr valign="top"><td>
344 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
345 <span class="sig-arg">callback</span>=<span class="sig-default">None</span>,
346 <span class="sig-arg">batch_uri</span>=<span class="sig-default">None</span>)</span>
347 <br /><em class="fname">(Constructor)</em>
348 </h3>
349 </td><td align="right" valign="top"
350 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.__init__">source&nbsp;code</a></span>&nbsp;
351 </td>
352 </tr></table>
353
354 <pre class="literalblock">
355Constructor for a BatchHttpRequest.
356
357Args:
358 callback: callable, A callback to be called for each response, of the
359 form callback(id, response). The first parameter is the request id, and
360 the second is the deserialized response object.
361 batch_uri: string, URI to send batch requests to.
362
363</pre>
364 <dl class="fields">
365 <dt>Overrides:
366 object.__init__
367 </dt>
368 </dl>
369</td></tr></table>
370</div>
371<a name="_refresh_and_apply_credentials"></a>
372<div class="private">
373<table class="details" border="1" cellpadding="3"
374 cellspacing="0" width="100%" bgcolor="white">
375<tr><td>
376 <table width="100%" cellpadding="0" cellspacing="0" border="0">
377 <tr valign="top"><td>
378 <h3 class="epydoc"><span class="sig"><span class="sig-name">_refresh_and_apply_credentials</span>(<span class="sig-arg">self</span>,
379 <span class="sig-arg">request</span>,
380 <span class="sig-arg">http</span>)</span>
381 </h3>
382 </td><td align="right" valign="top"
383 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._refresh_and_apply_credentials">source&nbsp;code</a></span>&nbsp;
384 </td>
385 </tr></table>
386
387 <pre class="literalblock">
388Refresh the credentials and apply to the request.
389
390Args:
391 request: HttpRequest, the request.
392 http: httplib2.Http, the global http object for the batch.
393
394</pre>
395 <dl class="fields">
396 </dl>
397</td></tr></table>
398</div>
399<a name="_id_to_header"></a>
400<div class="private">
401<table class="details" border="1" cellpadding="3"
402 cellspacing="0" width="100%" bgcolor="white">
403<tr><td>
404 <table width="100%" cellpadding="0" cellspacing="0" border="0">
405 <tr valign="top"><td>
406 <h3 class="epydoc"><span class="sig"><span class="sig-name">_id_to_header</span>(<span class="sig-arg">self</span>,
407 <span class="sig-arg">id_</span>)</span>
408 </h3>
409 </td><td align="right" valign="top"
410 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._id_to_header">source&nbsp;code</a></span>&nbsp;
411 </td>
412 </tr></table>
413
414 <pre class="literalblock">
415Convert an id to a Content-ID header value.
416
417Args:
418 id_: string, identifier of individual request.
419
420Returns:
421 A Content-ID header with the id_ encoded into it. A UUID is prepended to
422 the value because Content-ID headers are supposed to be universally
423 unique.
424
425</pre>
426 <dl class="fields">
427 </dl>
428</td></tr></table>
429</div>
430<a name="_header_to_id"></a>
431<div class="private">
432<table class="details" border="1" cellpadding="3"
433 cellspacing="0" width="100%" bgcolor="white">
434<tr><td>
435 <table width="100%" cellpadding="0" cellspacing="0" border="0">
436 <tr valign="top"><td>
437 <h3 class="epydoc"><span class="sig"><span class="sig-name">_header_to_id</span>(<span class="sig-arg">self</span>,
438 <span class="sig-arg">header</span>)</span>
439 </h3>
440 </td><td align="right" valign="top"
441 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._header_to_id">source&nbsp;code</a></span>&nbsp;
442 </td>
443 </tr></table>
444
445 <pre class="literalblock">
446Convert a Content-ID header value to an id.
447
448Presumes the Content-ID header conforms to the format that _id_to_header()
449returns.
450
451Args:
452 header: string, Content-ID header value.
453
454Returns:
455 The extracted id value.
456
457Raises:
458 BatchError if the header is not in the expected format.
459
460</pre>
461 <dl class="fields">
462 </dl>
463</td></tr></table>
464</div>
465<a name="_serialize_request"></a>
466<div class="private">
467<table class="details" border="1" cellpadding="3"
468 cellspacing="0" width="100%" bgcolor="white">
469<tr><td>
470 <table width="100%" cellpadding="0" cellspacing="0" border="0">
471 <tr valign="top"><td>
472 <h3 class="epydoc"><span class="sig"><span class="sig-name">_serialize_request</span>(<span class="sig-arg">self</span>,
473 <span class="sig-arg">request</span>)</span>
474 </h3>
475 </td><td align="right" valign="top"
476 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._serialize_request">source&nbsp;code</a></span>&nbsp;
477 </td>
478 </tr></table>
479
480 <pre class="literalblock">
481Convert an HttpRequest object into a string.
482
483Args:
484 request: HttpRequest, the request to serialize.
485
486Returns:
487 The request as a string in application/http format.
488
489</pre>
490 <dl class="fields">
491 </dl>
492</td></tr></table>
493</div>
494<a name="_deserialize_response"></a>
495<div class="private">
496<table class="details" border="1" cellpadding="3"
497 cellspacing="0" width="100%" bgcolor="white">
498<tr><td>
499 <table width="100%" cellpadding="0" cellspacing="0" border="0">
500 <tr valign="top"><td>
501 <h3 class="epydoc"><span class="sig"><span class="sig-name">_deserialize_response</span>(<span class="sig-arg">self</span>,
502 <span class="sig-arg">payload</span>)</span>
503 </h3>
504 </td><td align="right" valign="top"
505 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._deserialize_response">source&nbsp;code</a></span>&nbsp;
506 </td>
507 </tr></table>
508
509 <pre class="literalblock">
510Convert string into httplib2 response and content.
511
512Args:
513 payload: string, headers and body as a string.
514
515Returns:
516 A pair (resp, content) like would be returned from httplib2.request.
517
518</pre>
519 <dl class="fields">
520 </dl>
521</td></tr></table>
522</div>
523<a name="_new_id"></a>
524<div class="private">
525<table class="details" border="1" cellpadding="3"
526 cellspacing="0" width="100%" bgcolor="white">
527<tr><td>
528 <table width="100%" cellpadding="0" cellspacing="0" border="0">
529 <tr valign="top"><td>
530 <h3 class="epydoc"><span class="sig"><span class="sig-name">_new_id</span>(<span class="sig-arg">self</span>)</span>
531 </h3>
532 </td><td align="right" valign="top"
533 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._new_id">source&nbsp;code</a></span>&nbsp;
534 </td>
535 </tr></table>
536
537 <pre class="literalblock">
538Create a new id.
539
540Auto incrementing number that avoids conflicts with ids already used.
541
542Returns:
543 string, a new unique id.
544
545</pre>
546 <dl class="fields">
547 </dl>
548</td></tr></table>
549</div>
550<a name="add"></a>
551<div>
552<table class="details" border="1" cellpadding="3"
553 cellspacing="0" width="100%" bgcolor="white">
554<tr><td>
555 <table width="100%" cellpadding="0" cellspacing="0" border="0">
556 <tr valign="top"><td>
557 <h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">self</span>,
558 <span class="sig-arg">request</span>,
559 <span class="sig-arg">callback</span>=<span class="sig-default">None</span>,
560 <span class="sig-arg">request_id</span>=<span class="sig-default">None</span>)</span>
561 </h3>
562 </td><td align="right" valign="top"
563 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.add">source&nbsp;code</a></span>&nbsp;
564 </td>
565 </tr></table>
566
567 <pre class="literalblock">
568Add a new request.
569
570Every callback added will be paired with a unique id, the request_id. That
571unique id will be passed back to the callback when the response comes back
572from the server. The default behavior is to have the library generate it's
573own unique id. If the caller passes in a request_id then they must ensure
574uniqueness for each request_id, and if they are not an exception is
575raised. Callers should either supply all request_ids or nevery supply a
576request id, to avoid such an error.
577
578Args:
579 request: HttpRequest, Request to add to the batch.
580 callback: callable, A callback to be called for this response, of the
581 form callback(id, response). The first parameter is the request id, and
582 the second is the deserialized response object.
583 request_id: string, A unique id for the request. The id will be passed to
584 the callback with the response.
585
586Returns:
587 None
588
589Raises:
590 BatchError if a resumable request is added to a batch.
591 KeyError is the request_id is not unique.
592
593</pre>
594 <dl class="fields">
595 </dl>
596</td></tr></table>
597</div>
598<a name="_execute"></a>
599<div class="private">
600<table class="details" border="1" cellpadding="3"
601 cellspacing="0" width="100%" bgcolor="white">
602<tr><td>
603 <table width="100%" cellpadding="0" cellspacing="0" border="0">
604 <tr valign="top"><td>
605 <h3 class="epydoc"><span class="sig"><span class="sig-name">_execute</span>(<span class="sig-arg">self</span>,
606 <span class="sig-arg">http</span>,
607 <span class="sig-arg">order</span>,
608 <span class="sig-arg">requests</span>)</span>
609 </h3>
610 </td><td align="right" valign="top"
611 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest._execute">source&nbsp;code</a></span>&nbsp;
612 </td>
613 </tr></table>
614
615 <pre class="literalblock">
616Serialize batch request, send to server, process response.
617
618Args:
619 http: httplib2.Http, an http object to be used to make the request with.
620 order: list, list of request ids in the order they were added to the
621 batch.
622 request: list, list of request objects to send.
623
624Raises:
625 httplib2.Error if a transport error has occured.
626 apiclient.errors.BatchError if the response is the wrong format.
627
628</pre>
629 <dl class="fields">
630 </dl>
631</td></tr></table>
632</div>
633<a name="execute"></a>
634<div>
635<table class="details" border="1" cellpadding="3"
636 cellspacing="0" width="100%" bgcolor="white">
637<tr><td>
638 <table width="100%" cellpadding="0" cellspacing="0" border="0">
639 <tr valign="top"><td>
640 <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>,
641 <span class="sig-arg">http</span>=<span class="sig-default">None</span>)</span>
642 </h3>
643 </td><td align="right" valign="top"
644 ><span class="codelink"><a href="apiclient.http-pysrc.html#BatchHttpRequest.execute">source&nbsp;code</a></span>&nbsp;
645 </td>
646 </tr></table>
647
648 <pre class="literalblock">
649Execute all the requests as a single batched HTTP request.
650
651Args:
652 http: httplib2.Http, an http object to be used in place of the one the
653 HttpRequest request object was constructed with. If one isn't supplied
654 then use a http object from the requests in this batch.
655
656Returns:
657 None
658
659Raises:
660 httplib2.Error if a transport error has occured.
661 apiclient.errors.BatchError if the response is the wrong format.
662
663</pre>
664 <dl class="fields">
665 </dl>
666</td></tr></table>
667</div>
668<br />
669<!-- ==================== NAVIGATION BAR ==================== -->
670<table class="navbar" border="0" width="100%" cellpadding="0"
671 bgcolor="#a0c0ff" cellspacing="0">
672 <tr valign="middle">
673
674 <!-- Tree link -->
675 <th>&nbsp;&nbsp;&nbsp;<a
676 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
677
678 <!-- Index link -->
679 <th>&nbsp;&nbsp;&nbsp;<a
680 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
681
682 <!-- Help link -->
683 <th>&nbsp;&nbsp;&nbsp;<a
684 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
685
686 <th class="navbar" width="100%"></th>
687 </tr>
688</table>
689<table border="0" cellpadding="0" cellspacing="0" width="100%%">
690 <tr>
691 <td align="left" class="footer">
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame^]692 Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]693 </td>
694 <td align="right" class="footer">
695 <a target="mainFrame" href="http://epydoc.sourceforge.net"
696 >http://epydoc.sourceforge.net</a>
697 </td>
698 </tr>
699</table>
700
701<script type="text/javascript">
702 <!--
703 // Private objects are initially displayed (because if
704 // javascript is turned off then we want them to be
705 // visible); but by default, we want to hide them. So hide
706 // them unless we have a cookie that says to show them.
707 checkCookie();
708 // -->
709</script>
710</body>
711</html>