-
Notifications
You must be signed in to change notification settings - Fork 180
/
BlobDownloadOptions.yml
167 lines (154 loc) · 5.2 KB
/
BlobDownloadOptions.yml
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
### YamlMime:TSType
name: BlobDownloadOptions
uid: '@azure/storage-blob.BlobDownloadOptions'
package: '@azure/storage-blob'
summary: 'Options to configure the <xref:BlobClient.download> operation.'
fullName: BlobDownloadOptions
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: abortSignal
uid: '@azure/storage-blob.BlobDownloadOptions.abortSignal'
package: '@azure/storage-blob'
summary: >-
An implementation of the `AbortSignalLike` interface to signal the request
to cancel the operation.
For example, use the @azure/abort-controller to create an
`AbortSignal`.
fullName: abortSignal
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
type: AbortSignalLike
description: ''
- name: conditions
uid: '@azure/storage-blob.BlobDownloadOptions.conditions'
package: '@azure/storage-blob'
summary: Conditions to meet when downloading blobs.
fullName: conditions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'conditions?: BlobRequestConditions'
return:
type: <xref uid="@azure/storage-blob.BlobRequestConditions" />
description: ''
- name: customerProvidedKey
uid: '@azure/storage-blob.BlobDownloadOptions.customerProvidedKey'
package: '@azure/storage-blob'
summary: Customer Provided Key Info.
fullName: customerProvidedKey
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'customerProvidedKey?: CpkInfo'
return:
type: <xref uid="@azure/storage-blob.CpkInfo" />
description: ''
- name: maxRetryRequests
uid: '@azure/storage-blob.BlobDownloadOptions.maxRetryRequests'
package: '@azure/storage-blob'
summary: >
Optional. ONLY AVAILABLE IN NODE.JS.
How many retries will perform when original body download stream
unexpected ends.
Above kind of ends will not trigger retry policy defined in a pipeline,
because they doesn't emit network errors.
With this option, every additional retry means an additional
`FileClient.download()` request will be made
from the broken point, until the requested range has been successfully
downloaded or maxRetryRequests is reached.
Default value is 5, please set a larger value when loading large files in
poor network.
fullName: maxRetryRequests
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'maxRetryRequests?: number'
return:
type: number
description: ''
- name: onProgress
uid: '@azure/storage-blob.BlobDownloadOptions.onProgress'
package: '@azure/storage-blob'
summary: Call back to receive events on the progress of download operation.
fullName: onProgress
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'onProgress?: (progress: TransferProgressEvent) => void'
return:
type: '(progress: TransferProgressEvent) => void'
description: ''
- name: rangeGetContentCrc64
uid: '@azure/storage-blob.BlobDownloadOptions.rangeGetContentCrc64'
package: '@azure/storage-blob'
summary: >
When this is set to true and download range of blob, the service returns
the CRC64 hash for the range,
as long as the range is less than or equal to 4 MB in size.
rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.
fullName: rangeGetContentCrc64
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'rangeGetContentCrc64?: boolean'
return:
type: boolean
description: ''
- name: rangeGetContentMD5
uid: '@azure/storage-blob.BlobDownloadOptions.rangeGetContentMD5'
package: '@azure/storage-blob'
summary: >
When this is set to true and download range of blob, the service returns
the MD5 hash for the range,
as long as the range is less than or equal to 4 MB in size.
rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.
fullName: rangeGetContentMD5
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'rangeGetContentMD5?: boolean'
return:
type: boolean
description: ''
- name: snapshot
uid: '@azure/storage-blob.BlobDownloadOptions.snapshot'
package: '@azure/storage-blob'
summary: >-
An opaque DateTime string value that, when present, specifies the blob
snapshot to retrieve.
fullName: snapshot
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'snapshot?: string'
return:
type: string
description: ''
- name: tracingOptions
uid: '@azure/storage-blob.BlobDownloadOptions.tracingOptions'
package: '@azure/storage-blob'
summary: Options to configure spans created when tracing is enabled.
fullName: tracingOptions
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
type: OperationTracingOptions
description: ''
extends: <xref uid="@azure/storage-blob.CommonOptions" />