Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileReadToBufferOptions

Package version

Option interface for Data Lake file - readToBuffer operations

See:

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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.

Optional chunkSize

chunkSize: undefined | number

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.

Optional concurrency

concurrency: undefined | number

Concurrency of parallel read.

Optional conditions

Access conditions headers.

Optional customerProvidedKey

customerProvidedKey: CpkInfo

Customer Provided Key Info.

Optional maxRetryRequestsPerChunk

maxRetryRequestsPerChunk: undefined | number

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.

Optional onProgress

onProgress: undefined | ((progress: TransferProgressEvent) => void)

Progress updater.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Generated using TypeDoc