Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SendOptions

Package version

The set of options to configure the send operation on the EventHubProducer.

  • partitionKey : A value that is hashed to produce a partition assignment.
  • abortSignal : A signal used to cancel the send operation.

Example usage:

{
    partitionKey: 'foo'
}
internal

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike
property

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 parentSpan

parentSpan: Span | SpanContext

The Span or SpanContext to use as the parent of any spans created while sending events.

Optional partitionKey

partitionKey: string | null
property

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.

Generated using TypeDoc