FileReadToBufferOptions interface
- Extends
Properties
| abort |
An implementation of the |
| chunk |
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. |
| customer |
Customer Provided Key Info. |
| max |
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. |
| on |
Progress updater. |
Inherited Properties
| tracing |
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?: AbortSignalLikeProperty Value
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?: numberProperty Value
number
concurrency
Concurrency of parallel read.
concurrency?: numberProperty Value
number
conditions
Access conditions headers.
conditions?: DataLakeRequestConditionsProperty Value
customerProvidedKey
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?: numberProperty Value
number
onProgress
Progress updater.
onProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void