Package version:

Interface BlobDownloadToBufferOptions

Option interface for the BlobClient.downloadToBuffer operation.

interface BlobDownloadToBufferOptions {
    abortSignal?: any;
    blockSize?: number;
    concurrency?: number;
    conditions?: BlobRequestConditions;
    customerProvidedKey?: CpkInfo;
    maxRetryRequestsPerBlock?: number;
    onProgress?: ((progress: TransferProgressEvent) => void);
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? blockSize? concurrency? conditions? customerProvidedKey? maxRetryRequestsPerBlock? onProgress? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

OptionalblockSize

blockSize?: number

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.

Optionalconcurrency

concurrency?: number

Concurrency of parallel download.

Optionalconditions

conditions?: BlobRequestConditions

Access conditions headers.

OptionalcustomerProvidedKey

customerProvidedKey?: CpkInfo

Customer Provided Key Info.

OptionalmaxRetryRequestsPerBlock

maxRetryRequestsPerBlock?: number

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.

OptionalonProgress

onProgress?: ((progress: TransferProgressEvent) => void)

Progress updater.

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

Settings

Member Visibility