EnqueueEventOptions interface

Package:

@azure/event-hubs

Options to configure the enqueueEvents method on the EventHubBufferedProducerClient.

Extends

SendBatchOptions

Inherited Properties

abortSignal	The signal which can be used to abort requests.
partitionId	The partition this batch will be sent to. If this value is set then partitionKey can not be set.
partitionKey	A value that is hashed to produce a partition assignment. It guarantees that messages with the same partitionKey end up in the same partition. Specifying this will throw an error if the producer was created using a partitionId.
tracingOptions	Options for configuring tracing.

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From SendBatchOptions.abortSignal

partitionId

The partition this batch will be sent to. If this value is set then partitionKey can not be set.

partitionId?: string

Property Value

string

Inherited From SendBatchOptions.partitionId

partitionKey

A value that is hashed to produce a partition assignment. It guarantees that messages with the same partitionKey end up in the same partition. Specifying this will throw an error if the producer was created using a partitionId.

partitionKey?: string

Property Value

string

Inherited From SendBatchOptions.partitionKey

tracingOptions

Options for configuring tracing.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From SendBatchOptions.tracingOptions