BlobDownloadToBufferOptions interface

  • Reference
Package:
@azure/storage-blob

Option interface for the downloadToBuffer operation.

Extends
CommonOptions

Properties

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.
blockSize

blockSize is the data every request trying to download. Must be greater than or equal to 0. If set to 0 or undefined, blockSize will automatically calculated according to the blob size.
concurrency

Concurrency of parallel download.
conditions

Access conditions headers.
customerProvidedKey

Customer Provided Key Info.
maxRetryRequestsPerBlock

Optional. ONLY AVAILABLE IN NODE.JS.

How many retries will perform when original block 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 block has been successfully downloaded or maxRetryRequestsPerBlock is reached.

Default value is 5, please set a larger value when in poor network.
onProgress

Progress updater.

Inherited Properties

tracingOptions

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?: AbortSignalLike

Property Value

AbortSignalLike

blockSize

blockSize is the data every request trying to download. Must be greater than or equal to 0. If set to 0 or undefined, blockSize will automatically calculated according to the blob size.

blockSize?: number

Property Value

number

concurrency

Concurrency of parallel download.

concurrency?: number

Property Value

number

conditions

Access conditions headers.

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

maxRetryRequestsPerBlock

Optional. ONLY AVAILABLE IN NODE.JS.

How many retries will perform when original block 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 block has been successfully downloaded or maxRetryRequestsPerBlock is reached.

Default value is 5, please set a larger value when in poor network.

maxRetryRequestsPerBlock?: number

Property Value

number

onProgress

Progress updater.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions