IBlobDownloadOptions interface

Package:

@azure/storage-blob

Properties

blobAccessConditions
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 FileURL.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.
progress
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.
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.
snapshot	An opaque DateTime string value that, when present, specifies the blob snapshot to retrieve.

Property Details

blobAccessConditions

blobAccessConditions?: IBlobAccessConditions

Property Value

IBlobAccessConditions

customerProvidedKey

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

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 FileURL.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?: number

Property Value

number

progress

progress?: (progress: TransferProgressEvent) => void

Property 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?: boolean

Property 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?: boolean

Property Value

boolean

snapshot

An opaque DateTime string value that, when present, specifies the blob snapshot to retrieve.

snapshot?: string

Property Value

string