Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateBatchOptions

Package version

Options to configure the createBatch method on the EventHubProducerClient.

  • partitionKey : A value that is hashed to produce a partition assignment.
  • maxSizeInBytes: The upper limit for the size of batch.
  • abortSignal : A signal the request to cancel the send operation.

Example usage:

{
    partitionKey: 'foo',
    maxSizeInBytes: 1024 * 1024 // 1 MB
}

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

The signal which can be used to abort requests.

Optional maxSizeInBytes

maxSizeInBytes: undefined | number

The upper limit for the size of batch. The tryAdd function will return false after this limit is reached.

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. If this value is set then partitionId can not be set.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options for configuring tracing.

Generated using TypeDoc