Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BlockBlobQueryOptions

Package version

Options to configure BlockBlobClient.query operation.

Hierarchy

Index

Properties

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 conditions

conditions: BlobRequestConditions

Conditions to meet when uploading to the block blob.

Optional customerProvidedKey

customerProvidedKey: CpkInfo

Customer Provided Key Info.

Optional inputTextConfiguration

inputTextConfiguration: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryParquetConfiguration

Configurations for the query input.

Optional onError

onError: undefined | ((error: BlobQueryError) => void)

Callback to receive error events during the query operaiton.

Optional onProgress

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

Callback to receive events on the progress of query operation.

Optional outputTextConfiguration

outputTextConfiguration: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryArrowConfiguration

Configurations for the query output.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Generated using TypeDoc