| <?xml version="1.0" encoding="ascii"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| "DTD/xhtml1-transitional.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
| <head> | |
| <title>googleapiclient.http.BatchHttpRequest</title> | |
| <link rel="stylesheet" href="epydoc.css" type="text/css" /> | |
| <script type="text/javascript" src="epydoc.js"></script> | |
| </head> | |
| <body bgcolor="white" text="black" link="blue" vlink="#204080" | |
| alink="#204080"> | |
| <!-- ==================== NAVIGATION BAR ==================== --> | |
| <table class="navbar" border="0" width="100%" cellpadding="0" | |
| bgcolor="#a0c0ff" cellspacing="0"> | |
| <tr valign="middle"> | |
| <!-- Home link --> | |
| <th> <a | |
| href="googleapiclient-module.html">Home</a> </th> | |
| <!-- Tree link --> | |
| <th> <a | |
| href="module-tree.html">Trees</a> </th> | |
| <!-- Index link --> | |
| <th> <a | |
| href="identifier-index.html">Indices</a> </th> | |
| <!-- Help link --> | |
| <th> <a | |
| href="help.html">Help</a> </th> | |
| <th class="navbar" width="100%"></th> | |
| </tr> | |
| </table> | |
| <table width="100%" cellpadding="0" cellspacing="0"> | |
| <tr valign="top"> | |
| <td width="100%"> | |
| <span class="breadcrumbs"> | |
| <a href="googleapiclient-module.html">Package googleapiclient</a> :: | |
| <a href="googleapiclient.http-module.html">Module http</a> :: | |
| Class BatchHttpRequest | |
| </span> | |
| </td> | |
| <td> | |
| <table cellpadding="0" cellspacing="0"> | |
| <!-- hide/show private --> | |
| <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" | |
| onclick="toggle_private();">hide private</a>]</span></td></tr> | |
| <tr><td align="right"><span class="options" | |
| >[<a href="frames.html" target="_top">frames</a | |
| >] | <a href="googleapiclient.http.BatchHttpRequest-class.html" | |
| target="_top">no frames</a>]</span></td></tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== CLASS DESCRIPTION ==================== --> | |
| <h1 class="epydoc">Class BatchHttpRequest</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest">source code</a></span></p> | |
| <pre class="base-tree"> | |
| object --+ | |
| | | |
| <strong class="uidshort">BatchHttpRequest</strong> | |
| </pre> | |
| <hr /> | |
| <pre class="literalblock"> | |
| Batches multiple HttpRequest objects into a single HTTP request. | |
| Example: | |
| from googleapiclient.http import BatchHttpRequest | |
| def list_animals(request_id, response, exception): | |
| """Do something with the animals list response.""" | |
| if exception is not None: | |
| # Do something with the exception. | |
| pass | |
| else: | |
| # Do something with the response. | |
| pass | |
| def list_farmers(request_id, response, exception): | |
| """Do something with the farmers list response.""" | |
| if exception is not None: | |
| # Do something with the exception. | |
| pass | |
| else: | |
| # Do something with the response. | |
| pass | |
| service = build('farm', 'v2') | |
| batch = BatchHttpRequest() | |
| batch.add(service.animals().list(), list_animals) | |
| batch.add(service.farmers().list(), list_farmers) | |
| batch.execute(http=http) | |
| </pre> | |
| <!-- ==================== INSTANCE METHODS ==================== --> | |
| <a name="section-InstanceMethods"></a> | |
| <table class="summary" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Instance Methods</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-InstanceMethods" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.http.BatchHttpRequest-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>, | |
| <span class="summary-sig-arg">**kwargs</span>)</span><br /> | |
| Constructor for a BatchHttpRequest.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest.__init__">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.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>, | |
| <span class="summary-sig-arg">request</span>, | |
| <span class="summary-sig-arg">http</span>)</span><br /> | |
| Refresh the credentials and apply to the request.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._refresh_and_apply_credentials">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.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>, | |
| <span class="summary-sig-arg">id_</span>)</span><br /> | |
| Convert an id to a Content-ID header value.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._id_to_header">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.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>, | |
| <span class="summary-sig-arg">header</span>)</span><br /> | |
| Convert a Content-ID header value to an id.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._header_to_id">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.http.BatchHttpRequest-class.html#_serialize_request" class="summary-sig-name" onclick="show_private();">_serialize_request</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">request</span>)</span><br /> | |
| Convert an HttpRequest object into a string.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._serialize_request">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.http.BatchHttpRequest-class.html#_deserialize_response" class="summary-sig-name" onclick="show_private();">_deserialize_response</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">payload</span>)</span><br /> | |
| Convert string into httplib2 response and content.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._deserialize_response">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.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 /> | |
| Create a new id.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._new_id">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.http.BatchHttpRequest-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">*args</span>, | |
| <span class="summary-sig-arg">**kwargs</span>)</span><br /> | |
| Add a new request.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest.add">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.http.BatchHttpRequest-class.html#_execute" class="summary-sig-name" onclick="show_private();">_execute</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">http</span>, | |
| <span class="summary-sig-arg">order</span>, | |
| <span class="summary-sig-arg">requests</span>)</span><br /> | |
| Serialize batch request, send to server, process response.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._execute">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.http.BatchHttpRequest-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">*args</span>, | |
| <span class="summary-sig-arg">**kwargs</span>)</span><br /> | |
| Execute all the requests as a single batched HTTP request.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest.execute">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td colspan="2" class="summary"> | |
| <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: | |
| <code>__delattr__</code>, | |
| <code>__format__</code>, | |
| <code>__getattribute__</code>, | |
| <code>__hash__</code>, | |
| <code>__new__</code>, | |
| <code>__reduce__</code>, | |
| <code>__reduce_ex__</code>, | |
| <code>__repr__</code>, | |
| <code>__setattr__</code>, | |
| <code>__sizeof__</code>, | |
| <code>__str__</code>, | |
| <code>__subclasshook__</code> | |
| </p> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== PROPERTIES ==================== --> | |
| <a name="section-Properties"></a> | |
| <table class="summary" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Properties</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-Properties" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td colspan="2" class="summary"> | |
| <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: | |
| <code>__class__</code> | |
| </p> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== METHOD DETAILS ==================== --> | |
| <a name="section-MethodDetails"></a> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Method Details</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-MethodDetails" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <a name="__init__"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>, | |
| <span class="sig-arg">**kwargs</span>)</span> | |
| <br /><em class="fname">(Constructor)</em> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest.__init__">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Constructor for a BatchHttpRequest. | |
| Args: | |
| callback: callable, A callback to be called for each response, of the | |
| form callback(id, response, exception). The first parameter is the | |
| request id, and the second is the deserialized response object. The | |
| third is an googleapiclient.errors.HttpError exception object if an HTTP error | |
| occurred while processing the request, or None if no error occurred. | |
| batch_uri: string, URI to send batch requests to. | |
| </pre> | |
| <dl class="fields"> | |
| <dt>Decorators:</dt> | |
| <dd><ul class="nomargin-top"> | |
| <li><code>@util.positional(1)</code></li> | |
| </ul></dd> | |
| <dt>Overrides: | |
| object.__init__ | |
| </dt> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="_refresh_and_apply_credentials"></a> | |
| <div class="private"> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_refresh_and_apply_credentials</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">request</span>, | |
| <span class="sig-arg">http</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._refresh_and_apply_credentials">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Refresh the credentials and apply to the request. | |
| Args: | |
| request: HttpRequest, the request. | |
| http: httplib2.Http, the global http object for the batch. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="_id_to_header"></a> | |
| <div class="private"> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_id_to_header</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">id_</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._id_to_header">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Convert an id to a Content-ID header value. | |
| Args: | |
| id_: string, identifier of individual request. | |
| Returns: | |
| A Content-ID header with the id_ encoded into it. A UUID is prepended to | |
| the value because Content-ID headers are supposed to be universally | |
| unique. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="_header_to_id"></a> | |
| <div class="private"> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_header_to_id</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">header</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._header_to_id">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Convert a Content-ID header value to an id. | |
| Presumes the Content-ID header conforms to the format that _id_to_header() | |
| returns. | |
| Args: | |
| header: string, Content-ID header value. | |
| Returns: | |
| The extracted id value. | |
| Raises: | |
| BatchError if the header is not in the expected format. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="_serialize_request"></a> | |
| <div class="private"> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_serialize_request</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">request</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._serialize_request">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Convert an HttpRequest object into a string. | |
| Args: | |
| request: HttpRequest, the request to serialize. | |
| Returns: | |
| The request as a string in application/http format. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="_deserialize_response"></a> | |
| <div class="private"> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_deserialize_response</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">payload</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._deserialize_response">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Convert string into httplib2 response and content. | |
| Args: | |
| payload: string, headers and body as a string. | |
| Returns: | |
| A pair (resp, content), such as would be returned from httplib2.request. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="_new_id"></a> | |
| <div class="private"> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_new_id</span>(<span class="sig-arg">self</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._new_id">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Create a new id. | |
| Auto incrementing number that avoids conflicts with ids already used. | |
| Returns: | |
| string, a new unique id. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="add"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">add</span>(<span class="sig-arg">*args</span>, | |
| <span class="sig-arg">**kwargs</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest.add">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Add a new request. | |
| Every callback added will be paired with a unique id, the request_id. That | |
| unique id will be passed back to the callback when the response comes back | |
| from the server. The default behavior is to have the library generate it's | |
| own unique id. If the caller passes in a request_id then they must ensure | |
| uniqueness for each request_id, and if they are not an exception is | |
| raised. Callers should either supply all request_ids or never supply a | |
| request id, to avoid such an error. | |
| Args: | |
| request: HttpRequest, Request to add to the batch. | |
| callback: callable, A callback to be called for this response, of the | |
| form callback(id, response, exception). The first parameter is the | |
| request id, and the second is the deserialized response object. The | |
| third is an googleapiclient.errors.HttpError exception object if an HTTP error | |
| occurred while processing the request, or None if no errors occurred. | |
| request_id: string, A unique id for the request. The id will be passed | |
| to the callback with the response. | |
| Returns: | |
| None | |
| Raises: | |
| BatchError if a media request is added to a batch. | |
| KeyError is the request_id is not unique. | |
| </pre> | |
| <dl class="fields"> | |
| <dt>Decorators:</dt> | |
| <dd><ul class="nomargin-top"> | |
| <li><code>@util.positional(2)</code></li> | |
| </ul></dd> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="_execute"></a> | |
| <div class="private"> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_execute</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">http</span>, | |
| <span class="sig-arg">order</span>, | |
| <span class="sig-arg">requests</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest._execute">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Serialize batch request, send to server, process response. | |
| Args: | |
| http: httplib2.Http, an http object to be used to make the request with. | |
| order: list, list of request ids in the order they were added to the | |
| batch. | |
| requests: list, list of request objects to send. | |
| Raises: | |
| httplib2.HttpLib2Error if a transport error has occurred. | |
| googleapiclient.errors.BatchError if the response is the wrong format. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="execute"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">*args</span>, | |
| <span class="sig-arg">**kwargs</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.http-pysrc.html#BatchHttpRequest.execute">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Execute all the requests as a single batched HTTP request. | |
| Args: | |
| http: httplib2.Http, an http object to be used in place of the one the | |
| HttpRequest request object was constructed with. If one isn't supplied | |
| then use a http object from the requests in this batch. | |
| Returns: | |
| None | |
| Raises: | |
| httplib2.HttpLib2Error if a transport error has occurred. | |
| googleapiclient.errors.BatchError if the response is the wrong format. | |
| </pre> | |
| <dl class="fields"> | |
| <dt>Decorators:</dt> | |
| <dd><ul class="nomargin-top"> | |
| <li><code>@util.positional(1)</code></li> | |
| </ul></dd> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <br /> | |
| <!-- ==================== NAVIGATION BAR ==================== --> | |
| <table class="navbar" border="0" width="100%" cellpadding="0" | |
| bgcolor="#a0c0ff" cellspacing="0"> | |
| <tr valign="middle"> | |
| <!-- Home link --> | |
| <th> <a | |
| href="googleapiclient-module.html">Home</a> </th> | |
| <!-- Tree link --> | |
| <th> <a | |
| href="module-tree.html">Trees</a> </th> | |
| <!-- Index link --> | |
| <th> <a | |
| href="identifier-index.html">Indices</a> </th> | |
| <!-- Help link --> | |
| <th> <a | |
| href="help.html">Help</a> </th> | |
| <th class="navbar" width="100%"></th> | |
| </tr> | |
| </table> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%%"> | |
| <tr> | |
| <td align="left" class="footer"> | |
| Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 | |
| </td> | |
| <td align="right" class="footer"> | |
| <a target="mainFrame" href="http://epydoc.sourceforge.net" | |
| >http://epydoc.sourceforge.net</a> | |
| </td> | |
| </tr> | |
| </table> | |
| <script type="text/javascript"> | |
| <!-- | |
| // Private objects are initially displayed (because if | |
| // javascript is turned off then we want them to be | |
| // visible); but by default, we want to hide them. So hide | |
| // them unless we have a cookie that says to show them. | |
| checkCookie(); | |
| // --> | |
| </script> | |
| </body> | |
| </html> |