EventHubBufferedProducerClientOptions interface

Package:

@azure/event-hubs

Describes the options that can be provided while creating the EventHubBufferedProducerClient.

Extends

EventHubClientOptions

Properties

enableIdempotentRetries	Indicates whether or not the EventHubProducerClient should enable idempotent publishing to Event Hub partitions. If enabled, the producer will only be able to publish directly to partitions; it will not be able to publish to the Event Hubs gateway for automatic partition routing nor will it be able to use a partition key. Default: false
maxEventBufferLengthPerPartition	The total number of events that can be buffered for publishing at a given time for a given partition. Default: 1500
maxWaitTimeInMs	The amount of time to wait for a new event to be enqueued in the buffer before publishing a partially full batch. Default: 1 second.
onSendEventsErrorHandler	The handler to call when a batch fails to publish.
onSendEventsSuccessHandler	The handler to call once a batch has successfully published.

Inherited Properties

customEndpointAddress	A custom endpoint to use when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary. Example: "https://my.custom.endpoint:100/"
identifier	A unique name used to identify the client. If not provided, a GUID will be used as the identifier
retryOptions	Options to configure the retry policy for all the operations on the client. For example, { "maxRetries": 4 } or { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent	Value that is appended to the built in user agent string that is passed to the Event Hubs service.
webSocketOptions	Options to configure the channelling of the AMQP connection over Web Sockets.

Property Details

enableIdempotentRetries

Indicates whether or not the EventHubProducerClient should enable idempotent publishing to Event Hub partitions. If enabled, the producer will only be able to publish directly to partitions; it will not be able to publish to the Event Hubs gateway for automatic partition routing nor will it be able to use a partition key. Default: false

enableIdempotentRetries?: boolean

Property Value

boolean

maxEventBufferLengthPerPartition

The total number of events that can be buffered for publishing at a given time for a given partition.

Default: 1500

maxEventBufferLengthPerPartition?: number

Property Value

number

maxWaitTimeInMs

The amount of time to wait for a new event to be enqueued in the buffer before publishing a partially full batch.

Default: 1 second.

maxWaitTimeInMs?: number

Property Value

number

onSendEventsErrorHandler

The handler to call when a batch fails to publish.

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

Property Value

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

The handler to call once a batch has successfully published.

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

Property Value

(ctx: OnSendEventsSuccessContext) => void

Inherited Property Details

customEndpointAddress

A custom endpoint to use when connecting to the Event Hubs service. This can be useful when your network does not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an intermediary.

Example: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

Property Value

string

Inherited From EventHubClientOptions.customEndpointAddress

identifier

A unique name used to identify the client. If not provided, a GUID will be used as the identifier

identifier?: string

Property Value

string

Inherited From EventHubClientOptions.identifier

retryOptions

Options to configure the retry policy for all the operations on the client. For example, { "maxRetries": 4 } or { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Property Value

RetryOptions

Inherited From EventHubClientOptions.retryOptions

userAgent

Value that is appended to the built in user agent string that is passed to the Event Hubs service.

userAgent?: string

Property Value

string

Inherited From EventHubClientOptions.userAgent

webSocketOptions

Options to configure the channelling of the AMQP connection over Web Sockets.

webSocketOptions?: WebSocketOptions

Property Value

WebSocketOptions

Inherited From EventHubClientOptions.webSocketOptions