SendBatchOptions interface

Package:

@azure/event-hubs

Options to configure the sendBatch method on the EventHubProducerClient when sending an array of events. If partitionId is set, partitionKey must not be set and vice versa.

• partitionId : The partition this batch will be sent to.
• partitionKey : A value that is hashed to produce a partition assignment.
• abortSignal : A signal used to cancel the send operation.

Extends

OperationOptions

Properties

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.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
tracingOptions	Options for configuring tracing.

Property Details

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

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 Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

tracingOptions

Options for configuring tracing.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions