Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SendBatchOptions

Package version

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.

Hierarchy

Index

Properties

Properties

Optional abortSignal

abortSignal: AbortSignalLike

The signal which can be used to abort requests.

Optional partitionId

partitionId: undefined | string

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

Optional partitionKey

partitionKey: undefined | string

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 paritionId.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options for configuring tracing.

Generated using TypeDoc