-
Notifications
You must be signed in to change notification settings - Fork 45
/
google.resumable_media.requests.download.html
511 lines (382 loc) · 30 KB
/
google.resumable_media.requests.download.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>google.resumable_media.requests.download — google-resumable-media 0.4.1 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="google.resumable_media.requests.upload" href="google.resumable_media.requests.upload.html" />
<link rel="prev" title="google.resumable_media.requests" href="google.resumable_media.requests.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> google-resumable-media
</a>
<div class="version">
0.4.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="google.resumable_media.common.html"><code class="docutils literal notranslate"><span class="pre">google.resumable_media.common</span></code></a></li>
<li class="toctree-l1 current"><a class="reference internal" href="google.resumable_media.requests.html"><code class="docutils literal notranslate"><span class="pre">google.resumable_media.requests</span></code></a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="google.resumable_media.requests.html#authorized-transport">Authorized Transport</a></li>
<li class="toctree-l2"><a class="reference internal" href="google.resumable_media.requests.html#simple-downloads">Simple Downloads</a></li>
<li class="toctree-l2"><a class="reference internal" href="google.resumable_media.requests.html#chunked-downloads">Chunked Downloads</a></li>
<li class="toctree-l2"><a class="reference internal" href="google.resumable_media.requests.html#simple-uploads">Simple Uploads</a></li>
<li class="toctree-l2"><a class="reference internal" href="google.resumable_media.requests.html#multipart-uploads">Multipart Uploads</a></li>
<li class="toctree-l2"><a class="reference internal" href="google.resumable_media.requests.html#resumable-uploads">Resumable Uploads</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">google.resumable_media.requests.download</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="google.resumable_media.requests.upload.html"><code class="docutils literal notranslate"><span class="pre">google.resumable_media.requests.upload</span></code></a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">google-resumable-media</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><a href="google.resumable_media.requests.html"><code class="docutils literal notranslate"><span class="pre">google.resumable_media.requests</span></code></a> »</li>
<li><code class="docutils literal notranslate"><span class="pre">google.resumable_media.requests.download</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/google.resumable_media.requests.download.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-google.resumable_media.requests.download">
<span id="google-resumable-media-requests-download"></span><h1><code class="docutils literal notranslate"><span class="pre">google.resumable_media.requests.download</span></code><a class="headerlink" href="#module-google.resumable_media.requests.download" title="Permalink to this headline">¶</a></h1>
<p>Support for downloading media from Google APIs.</p>
<dl class="class">
<dt id="google.resumable_media.requests.download.ChunkedDownload">
<em class="property">class </em><code class="descclassname">google.resumable_media.requests.download.</code><code class="descname">ChunkedDownload</code><span class="sig-paren">(</span><em>media_url</em>, <em>chunk_size</em>, <em>stream</em>, <em>start=0</em>, <em>end=None</em>, <em>headers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">google.resumable_media.requests._helpers.RequestsMixin</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">google.resumable_media._download.ChunkedDownload</span></code></p>
<p>Download a resource in chunks from a Google API.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>media_url</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – The URL containing the media to be downloaded.</li>
<li><strong>chunk_size</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – The number of bytes to be retrieved in each
request.</li>
<li><strong>stream</strong> (<em>IO</em><em>[</em><a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#bytes" title="(in Python v3.6)"><em>bytes</em></a><em>]</em>) – A write-able stream (i.e. file-like object) that
will be used to concatenate chunks of the resource as they are
downloaded.</li>
<li><strong>start</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – The first byte in a range to be downloaded. If not
provided, defaults to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</li>
<li><strong>end</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – The last byte in a range to be downloaded. If not
provided, will download to the end of the media.</li>
<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Optional" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Optional</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Mapping" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Mapping</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> ] ]) – Extra headers that should
be sent with each request, e.g. headers for data encryption
key headers.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="google.resumable_media.requests.download.ChunkedDownload.media_url">
<code class="descname">media_url</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.media_url" title="Permalink to this definition">¶</a></dt>
<dd><p>The URL containing the media to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)">str</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="google.resumable_media.requests.download.ChunkedDownload.start">
<code class="descname">start</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.start" title="Permalink to this definition">¶</a></dt>
<dd><p>The first byte in a range to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Optional" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Optional</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> ]</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="google.resumable_media.requests.download.ChunkedDownload.end">
<code class="descname">end</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.end" title="Permalink to this definition">¶</a></dt>
<dd><p>The last byte in a range to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Optional" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Optional</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> ]</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="google.resumable_media.requests.download.ChunkedDownload.chunk_size">
<code class="descname">chunk_size</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.chunk_size" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of bytes to be retrieved in each request.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/exceptions.html#ValueError" title="(in Python v3.6)"><strong>ValueError</strong></a> – If <code class="docutils literal notranslate"><span class="pre">start</span></code> is negative.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.bytes_downloaded">
<em class="property">property </em><code class="descname">bytes_downloaded</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.bytes_downloaded" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of bytes that have been downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.consume_next_chunk">
<code class="descname">consume_next_chunk</code><span class="sig-paren">(</span><em>transport</em><span class="sig-paren">)</span><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.consume_next_chunk" title="Permalink to this definition">¶</a></dt>
<dd><p>Consume the next chunk of the resource to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>transport</strong> (<a class="reference external" href="http://requests.kennethreitz.org/en/stable/api/#requests.Session" title="(in Requests v2.22.0)"><em>Session</em></a>) – A <code class="docutils literal notranslate"><span class="pre">requests</span></code> object which can
make authenticated requests.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The HTTP response returned by <code class="docutils literal notranslate"><span class="pre">transport</span></code>.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="http://requests.kennethreitz.org/en/stable/api/#requests.Response" title="(in Requests v2.22.0)">Response</a></td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/exceptions.html#ValueError" title="(in Python v3.6)"><strong>ValueError</strong></a> – If the current download has finished.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.finished">
<em class="property">property </em><code class="descname">finished</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.finished" title="Permalink to this definition">¶</a></dt>
<dd><p>Flag indicating if the download has completed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/functions.html#bool" title="(in Python v3.6)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.invalid">
<em class="property">property </em><code class="descname">invalid</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.invalid" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates if the download is in an invalid state.</p>
<p>This will occur if a call to <a class="reference internal" href="#google.resumable_media.requests.download.ChunkedDownload.consume_next_chunk" title="google.resumable_media.requests.download.ChunkedDownload.consume_next_chunk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">consume_next_chunk()</span></code></a> fails.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/functions.html#bool" title="(in Python v3.6)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="google.resumable_media.requests.download.ChunkedDownload.total_bytes">
<em class="property">property </em><code class="descname">total_bytes</code><a class="headerlink" href="#google.resumable_media.requests.download.ChunkedDownload.total_bytes" title="Permalink to this definition">¶</a></dt>
<dd><p>The total number of bytes to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Optional" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Optional</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> ]</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="google.resumable_media.requests.download.Download">
<em class="property">class </em><code class="descclassname">google.resumable_media.requests.download.</code><code class="descname">Download</code><span class="sig-paren">(</span><em>media_url</em>, <em>stream=None</em>, <em>start=None</em>, <em>end=None</em>, <em>headers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#google.resumable_media.requests.download.Download" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">google.resumable_media.requests._helpers.RequestsMixin</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">google.resumable_media._download.Download</span></code></p>
<p>Helper to manage downloading a resource from a Google API.</p>
<p>“Slices” of the resource can be retrieved by specifying a range
with <code class="docutils literal notranslate"><span class="pre">start</span></code> and / or <code class="docutils literal notranslate"><span class="pre">end</span></code>. However, in typical usage, neither
<code class="docutils literal notranslate"><span class="pre">start</span></code> nor <code class="docutils literal notranslate"><span class="pre">end</span></code> is expected to be provided.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>media_url</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – The URL containing the media to be downloaded.</li>
<li><strong>stream</strong> (<em>IO</em><em>[</em><a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#bytes" title="(in Python v3.6)"><em>bytes</em></a><em>]</em>) – A write-able stream (i.e. file-like object) that
the downloaded resource can be written to.</li>
<li><strong>start</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – The first byte in a range to be downloaded. If not
provided, but <code class="docutils literal notranslate"><span class="pre">end</span></code> is provided, will download from the
beginning to <code class="docutils literal notranslate"><span class="pre">end</span></code> of the media.</li>
<li><strong>end</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – The last byte in a range to be downloaded. If not
provided, but <code class="docutils literal notranslate"><span class="pre">start</span></code> is provided, will download from the
<code class="docutils literal notranslate"><span class="pre">start</span></code> to the end of the media.</li>
<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Optional" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Optional</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Mapping" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Mapping</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> ] ]) – Extra headers that should
be sent with the request, e.g. headers for encrypted data.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="google.resumable_media.requests.download.Download.media_url">
<code class="descname">media_url</code><a class="headerlink" href="#google.resumable_media.requests.download.Download.media_url" title="Permalink to this definition">¶</a></dt>
<dd><p>The URL containing the media to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)">str</a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="google.resumable_media.requests.download.Download.start">
<code class="descname">start</code><a class="headerlink" href="#google.resumable_media.requests.download.Download.start" title="Permalink to this definition">¶</a></dt>
<dd><p>The first byte in a range to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Optional" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Optional</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> ]</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="google.resumable_media.requests.download.Download.end">
<code class="descname">end</code><a class="headerlink" href="#google.resumable_media.requests.download.Download.end" title="Permalink to this definition">¶</a></dt>
<dd><p>The last byte in a range to be downloaded.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/typing.html#typing.Optional" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Optional</span></code></a> [ <a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> ]</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="google.resumable_media.requests.download.Download.consume">
<code class="descname">consume</code><span class="sig-paren">(</span><em>transport</em><span class="sig-paren">)</span><a class="headerlink" href="#google.resumable_media.requests.download.Download.consume" title="Permalink to this definition">¶</a></dt>
<dd><p>Consume the resource to be downloaded.</p>
<p>If a <code class="docutils literal notranslate"><span class="pre">stream</span></code> is attached to this download, then the downloaded
resource will be written to the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>transport</strong> (<a class="reference external" href="http://requests.kennethreitz.org/en/stable/api/#requests.Session" title="(in Requests v2.22.0)"><em>Session</em></a>) – A <code class="docutils literal notranslate"><span class="pre">requests</span></code> object which can
make authenticated requests.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The HTTP response returned by <code class="docutils literal notranslate"><span class="pre">transport</span></code>.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="http://requests.kennethreitz.org/en/stable/api/#requests.Response" title="(in Requests v2.22.0)">Response</a></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="google.resumable_media.common.html#google.resumable_media.common.DataCorruption" title="google.resumable_media.common.DataCorruption"><strong>DataCorruption</strong></a> – If the download’s
checksum doesn’t agree with server-computed checksum.</li>
<li><a class="reference external" href="https://docs.python.org/3.6/library/exceptions.html#ValueError" title="(in Python v3.6)"><strong>ValueError</strong></a> – If the current <a class="reference internal" href="#google.resumable_media.requests.download.Download" title="google.resumable_media.requests.download.Download"><code class="xref py py-class docutils literal notranslate"><span class="pre">Download</span></code></a> has already
finished.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="google.resumable_media.requests.download.Download.finished">
<em class="property">property </em><code class="descname">finished</code><a class="headerlink" href="#google.resumable_media.requests.download.Download.finished" title="Permalink to this definition">¶</a></dt>
<dd><p>Flag indicating if the download has completed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3.6/library/functions.html#bool" title="(in Python v3.6)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="google.resumable_media.requests.upload.html" class="btn btn-neutral float-right" title="google.resumable_media.requests.upload" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="google.resumable_media.requests.html" class="btn btn-neutral float-left" title="google.resumable_media.requests" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Google
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>