Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventHubBufferedProducerClientOptions

Package version

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

Hierarchy

Index

Properties

Properties

Optional customEndpointAddress

customEndpointAddress: undefined | string

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/"

Optional maxEventBufferLengthPerPartition

maxEventBufferLengthPerPartition: undefined | number

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

Default: 1500

Optional maxWaitTimeInMs

maxWaitTimeInMs: undefined | number

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

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => Promise<void>

The handler to call when a batch fails to publish.

Type declaration

Optional onSendEventsSuccessHandler

onSendEventsSuccessHandler: undefined | ((ctx: OnSendEventsSuccessContext) => Promise<void>)

The handler to call once a batch has successfully published.

Optional retryOptions

retryOptions: RetryOptions

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

Optional userAgent

userAgent: undefined | string

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

Optional webSocketOptions

webSocketOptions: WebSocketOptions

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

Generated using TypeDoc