OLD | NEW |
(Empty) | |
| 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.HttpRequest</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> <a |
| 20 href="module-tree.html">Trees</a> </th> |
| 21 |
| 22 <!-- Index link --> |
| 23 <th> <a |
| 24 href="identifier-index.html">Indices</a> </th> |
| 25 |
| 26 <!-- Help link --> |
| 27 <th> <a |
| 28 href="help.html">Help</a> </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 apiclient</a> :: |
| 38 <a href="apiclient.http-module.html">Module http</a> :: |
| 39 Class HttpRequest |
| 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 private</a>]</span></td></tr> |
| 47 <tr><td align="right"><span class="options" |
| 48 >[<a href="frames.html" target="_top">frames</a |
| 49 >] | <a href="apiclient.http.HttpRequest-class.html" |
| 50 target="_top">no frames</a>]</span></td></tr> |
| 51 </table> |
| 52 </td> |
| 53 </tr> |
| 54 </table> |
| 55 <!-- ==================== CLASS DESCRIPTION ==================== --> |
| 56 <h1 class="epydoc">Class HttpRequest</h1><p class="nomargin-top"><span class="co
delink"><a href="apiclient.http-pysrc.html#HttpRequest">source code</a></sp
an></p> |
| 57 <center> |
| 58 <center> <map id="uml_class_diagram_for_apiclien_15" name="uml_class_diagram_fo
r_apiclien_15"> |
| 59 <area shape="rect" href="apiclient.http.HttpRequest-class.html#__init__" title="
Constructor for an HttpRequest." alt="" coords="17,36,665,55"/> |
| 60 <area shape="rect" href="apiclient.http.HttpRequest-class.html#execute" title="E
xecute the request." alt="" coords="17,55,665,73"/> |
| 61 <area shape="rect" href="apiclient.http.HttpRequest-class.html#next_chunk" title
="Execute the next step of a resumable upload." alt="" coords="17,73,665,92"/> |
| 62 <area shape="rect" href="apiclient.http.HttpRequest-class.html#to_json" title="R
eturns a JSON representation of the HttpRequest." alt="" coords="17,92,665,111"/
> |
| 63 <area shape="rect" href="apiclient.http.HttpRequest-class.html#from_json" title=
"Returns an HttpRequest populated with info from a JSON object." alt="" coords="
17,111,665,129"/> |
| 64 <area shape="rect" href="apiclient.http.HttpRequest-class.html" title="Encapsula
tes a single HTTP request." alt="" coords="16,11,667,131"/> |
| 65 </map> |
| 66 <img src="uml_class_diagram_for_apiclien_15.gif" alt='' usemap="#uml_class_dia
gram_for_apiclien_15" ismap="ismap" class="graph-without-title" /> |
| 67 </center> |
| 68 </center> |
| 69 <hr /> |
| 70 <pre class="literalblock"> |
| 71 Encapsulates a single HTTP request. |
| 72 |
| 73 </pre> |
| 74 |
| 75 <!-- ==================== INSTANCE METHODS ==================== --> |
| 76 <a name="section-InstanceMethods"></a> |
| 77 <table class="summary" border="1" cellpadding="3" |
| 78 cellspacing="0" width="100%" bgcolor="white"> |
| 79 <tr bgcolor="#70b0f0" class="table-header"> |
| 80 <td colspan="2" class="table-header"> |
| 81 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 82 <tr valign="top"> |
| 83 <td align="left"><span class="table-header">Instance Methods</span></td> |
| 84 <td align="right" valign="top" |
| 85 ><span class="options">[<a href="#section-InstanceMethods" |
| 86 class="privatelink" onclick="toggle_private();" |
| 87 >hide private</a>]</span></td> |
| 88 </tr> |
| 89 </table> |
| 90 </td> |
| 91 </tr> |
| 92 <tr> |
| 93 <td width="15%" align="right" valign="top" class="summary"> |
| 94 <span class="summary-type"> </span> |
| 95 </td><td class="summary"> |
| 96 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 97 <tr> |
| 98 <td><span class="summary-sig"><a href="apiclient.http.HttpRequest-clas
s.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-
arg">self</span>, |
| 99 <span class="summary-sig-arg">http</span>, |
| 100 <span class="summary-sig-arg">postproc</span>, |
| 101 <span class="summary-sig-arg">uri</span>, |
| 102 <span class="summary-sig-arg">method</span>=<span class="summary-sig-def
ault"><code class="variable-quote">'</code><code class="variable-string">GET</co
de><code class="variable-quote">'</code></span>, |
| 103 <span class="summary-sig-arg">body</span>=<span class="summary-sig-defau
lt">None</span>, |
| 104 <span class="summary-sig-arg">headers</span>=<span class="summary-sig-de
fault">None</span>, |
| 105 <span class="summary-sig-arg">methodId</span>=<span class="summary-sig-d
efault">None</span>, |
| 106 <span class="summary-sig-arg">resumable</span>=<span class="summary-sig-
default">None</span>)</span><br /> |
| 107 Constructor for an HttpRequest.</td> |
| 108 <td align="right" valign="top"> |
| 109 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpReques
t.__init__">source code</a></span> |
| 110 ············ |
| 111 </td> |
| 112 </tr> |
| 113 </table> |
| 114 ······ |
| 115 </td> |
| 116 </tr> |
| 117 <tr> |
| 118 <td width="15%" align="right" valign="top" class="summary"> |
| 119 <span class="summary-type"> </span> |
| 120 </td><td class="summary"> |
| 121 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 122 <tr> |
| 123 <td><span class="summary-sig"><a href="apiclient.http.HttpRequest-clas
s.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-ar
g">self</span>, |
| 124 <span class="summary-sig-arg">http</span>=<span class="summary-sig-defau
lt">None</span>)</span><br /> |
| 125 Execute the request.</td> |
| 126 <td align="right" valign="top"> |
| 127 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpReques
t.execute">source code</a></span> |
| 128 ············ |
| 129 </td> |
| 130 </tr> |
| 131 </table> |
| 132 ······ |
| 133 </td> |
| 134 </tr> |
| 135 <tr> |
| 136 <td width="15%" align="right" valign="top" class="summary"> |
| 137 <span class="summary-type"> </span> |
| 138 </td><td class="summary"> |
| 139 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 140 <tr> |
| 141 <td><span class="summary-sig"><a href="apiclient.http.HttpRequest-clas
s.html#next_chunk" class="summary-sig-name">next_chunk</a>(<span class="summary-
sig-arg">self</span>, |
| 142 <span class="summary-sig-arg">http</span>=<span class="summary-sig-defau
lt">None</span>)</span><br /> |
| 143 Execute the next step of a resumable upload.</td> |
| 144 <td align="right" valign="top"> |
| 145 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpReques
t.next_chunk">source code</a></span> |
| 146 ············ |
| 147 </td> |
| 148 </tr> |
| 149 </table> |
| 150 ······ |
| 151 </td> |
| 152 </tr> |
| 153 <tr> |
| 154 <td width="15%" align="right" valign="top" class="summary"> |
| 155 <span class="summary-type"> </span> |
| 156 </td><td class="summary"> |
| 157 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 158 <tr> |
| 159 <td><span class="summary-sig"><a name="to_json"></a><span class="summa
ry-sig-name">to_json</span>(<span class="summary-sig-arg">self</span>)</span><br
/> |
| 160 Returns a JSON representation of the HttpRequest.</td> |
| 161 <td align="right" valign="top"> |
| 162 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpReques
t.to_json">source code</a></span> |
| 163 ············ |
| 164 </td> |
| 165 </tr> |
| 166 </table> |
| 167 ······ |
| 168 </td> |
| 169 </tr> |
| 170 <tr> |
| 171 <td colspan="2" class="summary"> |
| 172 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 173 <code>__delattr__</code>, |
| 174 <code>__format__</code>, |
| 175 <code>__getattribute__</code>, |
| 176 <code>__hash__</code>, |
| 177 <code>__new__</code>, |
| 178 <code>__reduce__</code>, |
| 179 <code>__reduce_ex__</code>, |
| 180 <code>__repr__</code>, |
| 181 <code>__setattr__</code>, |
| 182 <code>__sizeof__</code>, |
| 183 <code>__str__</code>, |
| 184 <code>__subclasshook__</code> |
| 185 </p> |
| 186 </td> |
| 187 </tr> |
| 188 </table> |
| 189 <!-- ==================== STATIC METHODS ==================== --> |
| 190 <a name="section-StaticMethods"></a> |
| 191 <table class="summary" border="1" cellpadding="3" |
| 192 cellspacing="0" width="100%" bgcolor="white"> |
| 193 <tr bgcolor="#70b0f0" class="table-header"> |
| 194 <td colspan="2" class="table-header"> |
| 195 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 196 <tr valign="top"> |
| 197 <td align="left"><span class="table-header">Static Methods</span></td> |
| 198 <td align="right" valign="top" |
| 199 ><span class="options">[<a href="#section-StaticMethods" |
| 200 class="privatelink" onclick="toggle_private();" |
| 201 >hide private</a>]</span></td> |
| 202 </tr> |
| 203 </table> |
| 204 </td> |
| 205 </tr> |
| 206 <tr> |
| 207 <td width="15%" align="right" valign="top" class="summary"> |
| 208 <span class="summary-type"> </span> |
| 209 </td><td class="summary"> |
| 210 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 211 <tr> |
| 212 <td><span class="summary-sig"><a name="from_json"></a><span class="sum
mary-sig-name">from_json</span>(<span class="summary-sig-arg">s</span>, |
| 213 <span class="summary-sig-arg">http</span>, |
| 214 <span class="summary-sig-arg">postproc</span>)</span><br /> |
| 215 Returns an HttpRequest populated with info from a JSON object.</td> |
| 216 <td align="right" valign="top"> |
| 217 <span class="codelink"><a href="apiclient.http-pysrc.html#HttpReques
t.from_json">source code</a></span> |
| 218 ············ |
| 219 </td> |
| 220 </tr> |
| 221 </table> |
| 222 ······ |
| 223 </td> |
| 224 </tr> |
| 225 </table> |
| 226 <!-- ==================== PROPERTIES ==================== --> |
| 227 <a name="section-Properties"></a> |
| 228 <table class="summary" border="1" cellpadding="3" |
| 229 cellspacing="0" width="100%" bgcolor="white"> |
| 230 <tr bgcolor="#70b0f0" class="table-header"> |
| 231 <td colspan="2" class="table-header"> |
| 232 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 233 <tr valign="top"> |
| 234 <td align="left"><span class="table-header">Properties</span></td> |
| 235 <td align="right" valign="top" |
| 236 ><span class="options">[<a href="#section-Properties" |
| 237 class="privatelink" onclick="toggle_private();" |
| 238 >hide private</a>]</span></td> |
| 239 </tr> |
| 240 </table> |
| 241 </td> |
| 242 </tr> |
| 243 <tr> |
| 244 <td colspan="2" class="summary"> |
| 245 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 246 <code>__class__</code> |
| 247 </p> |
| 248 </td> |
| 249 </tr> |
| 250 </table> |
| 251 <!-- ==================== METHOD DETAILS ==================== --> |
| 252 <a name="section-MethodDetails"></a> |
| 253 <table class="details" border="1" cellpadding="3" |
| 254 cellspacing="0" width="100%" bgcolor="white"> |
| 255 <tr bgcolor="#70b0f0" class="table-header"> |
| 256 <td colspan="2" class="table-header"> |
| 257 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 258 <tr valign="top"> |
| 259 <td align="left"><span class="table-header">Method Details</span></td> |
| 260 <td align="right" valign="top" |
| 261 ><span class="options">[<a href="#section-MethodDetails" |
| 262 class="privatelink" onclick="toggle_private();" |
| 263 >hide private</a>]</span></td> |
| 264 </tr> |
| 265 </table> |
| 266 </td> |
| 267 </tr> |
| 268 </table> |
| 269 <a name="__init__"></a> |
| 270 <div> |
| 271 <table class="details" border="1" cellpadding="3" |
| 272 cellspacing="0" width="100%" bgcolor="white"> |
| 273 <tr><td> |
| 274 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 275 <tr valign="top"><td> |
| 276 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<s
pan class="sig-arg">self</span>, |
| 277 <span class="sig-arg">http</span>, |
| 278 <span class="sig-arg">postproc</span>, |
| 279 <span class="sig-arg">uri</span>, |
| 280 <span class="sig-arg">method</span>=<span class="sig-default"><code clas
s="variable-quote">'</code><code class="variable-string">GET</code><code class="
variable-quote">'</code></span>, |
| 281 <span class="sig-arg">body</span>=<span class="sig-default">None</span>, |
| 282 <span class="sig-arg">headers</span>=<span class="sig-default">None</spa
n>, |
| 283 <span class="sig-arg">methodId</span>=<span class="sig-default">None</sp
an>, |
| 284 <span class="sig-arg">resumable</span>=<span class="sig-default">None</s
pan>)</span> |
| 285 <br /><em class="fname">(Constructor)</em> |
| 286 </h3> |
| 287 </td><td align="right" valign="top" |
| 288 ><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.__ini
t__">source code</a></span> |
| 289 </td> |
| 290 </tr></table> |
| 291 ·· |
| 292 <pre class="literalblock"> |
| 293 Constructor for an HttpRequest. |
| 294 |
| 295 Args: |
| 296 http: httplib2.Http, the transport object to use to make a request |
| 297 postproc: callable, called on the HTTP response and content to transform |
| 298 it into a data object before returning, or raising an exception |
| 299 on an error. |
| 300 uri: string, the absolute URI to send the request to |
| 301 method: string, the HTTP method to use |
| 302 body: string, the request body of the HTTP request, |
| 303 headers: dict, the HTTP request headers |
| 304 methodId: string, a unique identifier for the API method being called. |
| 305 resumable: MediaUpload, None if this is not a resumbale request. |
| 306 |
| 307 </pre> |
| 308 <dl class="fields"> |
| 309 <dt>Overrides: |
| 310 object.__init__ |
| 311 </dt> |
| 312 </dl> |
| 313 </td></tr></table> |
| 314 </div> |
| 315 <a name="execute"></a> |
| 316 <div> |
| 317 <table class="details" border="1" cellpadding="3" |
| 318 cellspacing="0" width="100%" bgcolor="white"> |
| 319 <tr><td> |
| 320 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 321 <tr valign="top"><td> |
| 322 <h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<sp
an class="sig-arg">self</span>, |
| 323 <span class="sig-arg">http</span>=<span class="sig-default">None</span>)
</span> |
| 324 </h3> |
| 325 </td><td align="right" valign="top" |
| 326 ><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.execu
te">source code</a></span> |
| 327 </td> |
| 328 </tr></table> |
| 329 ·· |
| 330 <pre class="literalblock"> |
| 331 Execute the request. |
| 332 |
| 333 Args: |
| 334 http: httplib2.Http, an http object to be used in place of the |
| 335 one the HttpRequest request object was constructed with. |
| 336 |
| 337 Returns: |
| 338 A deserialized object model of the response body as determined |
| 339 by the postproc. |
| 340 |
| 341 Raises: |
| 342 apiclient.errors.HttpError if the response was not a 2xx. |
| 343 httplib2.Error if a transport error has occured. |
| 344 |
| 345 </pre> |
| 346 <dl class="fields"> |
| 347 </dl> |
| 348 </td></tr></table> |
| 349 </div> |
| 350 <a name="next_chunk"></a> |
| 351 <div> |
| 352 <table class="details" border="1" cellpadding="3" |
| 353 cellspacing="0" width="100%" bgcolor="white"> |
| 354 <tr><td> |
| 355 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 356 <tr valign="top"><td> |
| 357 <h3 class="epydoc"><span class="sig"><span class="sig-name">next_chunk</span>(
<span class="sig-arg">self</span>, |
| 358 <span class="sig-arg">http</span>=<span class="sig-default">None</span>)
</span> |
| 359 </h3> |
| 360 </td><td align="right" valign="top" |
| 361 ><span class="codelink"><a href="apiclient.http-pysrc.html#HttpRequest.next_
chunk">source code</a></span> |
| 362 </td> |
| 363 </tr></table> |
| 364 ·· |
| 365 <pre class="literalblock"> |
| 366 Execute the next step of a resumable upload. |
| 367 |
| 368 Can only be used if the method being executed supports media uploads and |
| 369 the MediaUpload object passed in was flagged as using resumable upload. |
| 370 |
| 371 Example: |
| 372 |
| 373 media = MediaFileUpload('smiley.png', mimetype='image/png', |
| 374 chunksize=1000, resumable=True) |
| 375 request = service.objects().insert( |
| 376 bucket=buckets['items'][0]['id'], |
| 377 name='smiley.png', |
| 378 media_body=media) |
| 379 |
| 380 response = None |
| 381 while response is None: |
| 382 status, response = request.next_chunk() |
| 383 if status: |
| 384 print "Upload %d%% complete." % int(status.progress() * 100) |
| 385 |
| 386 |
| 387 Returns: |
| 388 (status, body): (ResumableMediaStatus, object) |
| 389 The body will be None until the resumable media is fully uploaded. |
| 390 |
| 391 </pre> |
| 392 <dl class="fields"> |
| 393 </dl> |
| 394 </td></tr></table> |
| 395 </div> |
| 396 <br /> |
| 397 <!-- ==================== NAVIGATION BAR ==================== --> |
| 398 <table class="navbar" border="0" width="100%" cellpadding="0" |
| 399 bgcolor="#a0c0ff" cellspacing="0"> |
| 400 <tr valign="middle"> |
| 401 |
| 402 <!-- Tree link --> |
| 403 <th> <a |
| 404 href="module-tree.html">Trees</a> </th> |
| 405 |
| 406 <!-- Index link --> |
| 407 <th> <a |
| 408 href="identifier-index.html">Indices</a> </th> |
| 409 |
| 410 <!-- Help link --> |
| 411 <th> <a |
| 412 href="help.html">Help</a> </th> |
| 413 |
| 414 <th class="navbar" width="100%"></th> |
| 415 </tr> |
| 416 </table> |
| 417 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 418 <tr> |
| 419 <td align="left" class="footer"> |
| 420 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:06 2012 |
| 421 </td> |
| 422 <td align="right" class="footer"> |
| 423 <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 424 >http://epydoc.sourceforge.net</a> |
| 425 </td> |
| 426 </tr> |
| 427 </table> |
| 428 |
| 429 <script type="text/javascript"> |
| 430 <!-- |
| 431 // Private objects are initially displayed (because if |
| 432 // javascript is turned off then we want them to be |
| 433 // visible); but by default, we want to hide them. So hide |
| 434 // them unless we have a cookie that says to show them. |
| 435 checkCookie(); |
| 436 // --> |
| 437 </script> |
| 438 </body> |
| 439 </html> |
OLD | NEW |