FileReadToBufferOptions interface

Package:

@azure/storage-file-datalake

Option interface for Data Lake file - readToBuffer operations

See:

• readToBuffer

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.
chunkSize	chunkSize is size of data every request trying to read. Must be greater than or equal to 0, if set to 0 or undefined, it will automatically calculated according to the file size.
concurrency	Concurrency of parallel read.
conditions	Access conditions headers.
customerProvidedKey	Customer Provided Key Info.
maxRetryRequestsPerChunk	How many retries will perform for each read when the original chunk read stream ends unexpectedly. Above kind of ends will not trigger retry policy defined in a pipeline, because they doesn't emit network errors. Default value is 5.
onProgress	Progress updater.

Inherited Properties

tracingOptions

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

chunkSize

chunkSize is size of data every request trying to read. Must be greater than or equal to 0, if set to 0 or undefined, it will automatically calculated according to the file size.

chunkSize?: number

Property Value

number

concurrency

Concurrency of parallel read.

concurrency?: number

Property Value

number

conditions

Access conditions headers.

conditions?: DataLakeRequestConditions

Property Value

DataLakeRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

maxRetryRequestsPerChunk

How many retries will perform for each read when the original chunk read stream ends unexpectedly. Above kind of ends will not trigger retry policy defined in a pipeline, because they doesn't emit network errors. Default value is 5.

maxRetryRequestsPerChunk?: number

Property Value

number

onProgress

Progress updater.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions