BlobDownloadOptions interface
Options to configure the download operation.
- Extends
Properties
| abort |
An implementation of the |
| conditions | Conditions to meet when downloading blobs. |
| customer |
Customer Provided Key Info. |
| max |
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 Default value is 5, please set a larger value when loading large files in poor network. |
| on |
Call back to receive events on the progress of download operation. |
| range |
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. |
| range |
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. |
| snapshot | An opaque DateTime string value that, when present, specifies the blob snapshot to retrieve. |
Inherited Properties
| tracing |
Options to configure spans created when tracing is enabled. |
Property Details
abortSignal
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.
abortSignal?: AbortSignalLikeProperty Value
conditions
Conditions to meet when downloading blobs.
conditions?: BlobRequestConditionsProperty Value
customerProvidedKey
maxRetryRequests
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.
maxRetryRequests?: numberProperty Value
number
onProgress
Call back to receive events on the progress of download operation.
onProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void
rangeGetContentCrc64
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.
rangeGetContentCrc64?: booleanProperty Value
boolean
rangeGetContentMD5
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.
rangeGetContentMD5?: booleanProperty Value
boolean
snapshot
An opaque DateTime string value that, when present, specifies the blob snapshot to retrieve.
snapshot?: stringProperty Value
string
Inherited Property Details
tracingOptions
Options to configure spans created when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
Inherited From CommonOptions.tracingOptions