Compartir a través de

EventHubBufferedProducerClientOptions interface

  • Referencia
Paquete:
@azure/event-hubs

Describe las opciones que se pueden proporcionar al crear .EventHubBufferedProducerClient

Extends
EventHubClientOptions

Propiedades

enableIdempotentRetries

Indica si EventHubProducerClient debe habilitar la publicación idempotente en particiones de Event Hub. Si está habilitado, el productor solo podrá publicar directamente en particiones; no podrá publicar en la puerta de enlace de Event Hubs para el enrutamiento automático de particiones ni podrá usar una clave de partición. Valor predeterminado: false
maxEventBufferLengthPerPartition

Número total de eventos que se pueden almacenar en búfer para la publicación en un momento dado para una partición determinada.

Valor predeterminado: 1500
maxWaitTimeInMs

Cantidad de tiempo que se esperará a que se poner en cola un nuevo evento en el búfer antes de publicar un lote parcialmente completo.

Valor predeterminado: 1 segundo.
onSendEventsErrorHandler

Controlador al que se llamará cuando un lote no se puede publicar.
onSendEventsSuccessHandler

Controlador al que se llamará una vez que un lote se haya publicado correctamente.

Propiedades heredadas

customEndpointAddress

Un punto de conexión personalizado que se usará al conectarse al servicio Event Hubs. Esto puede ser útil cuando la red no permite conectarse a la dirección del punto de conexión de Azure Event Hubs estándar, pero permite conectarse a través de un intermediario.

Ejemplo: "https://my.custom.endpoint:100/"
identifier

Un nombre único que se usa para identificar al cliente. Si no se proporciona, se usará un GUID como identificador.
retryOptions

Opciones para configurar la directiva de reintentos para todas las operaciones del cliente. Por ejemplo, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Valor que se anexa a la cadena del agente de usuario integrada que se pasa al servicio Event Hubs.
webSocketOptions

Opciones para configurar el canalización de la conexión AMQP a través de web Sockets.

Detalles de las propiedades

enableIdempotentRetries

Indica si EventHubProducerClient debe habilitar la publicación idempotente en particiones de Event Hub. Si está habilitado, el productor solo podrá publicar directamente en particiones; no podrá publicar en la puerta de enlace de Event Hubs para el enrutamiento automático de particiones ni podrá usar una clave de partición. Valor predeterminado: false

enableIdempotentRetries?: boolean

Valor de propiedad

boolean

maxEventBufferLengthPerPartition

Número total de eventos que se pueden almacenar en búfer para la publicación en un momento dado para una partición determinada.

Valor predeterminado: 1500

maxEventBufferLengthPerPartition?: number

Valor de propiedad

number

maxWaitTimeInMs

Cantidad de tiempo que se esperará a que se poner en cola un nuevo evento en el búfer antes de publicar un lote parcialmente completo.

Valor predeterminado: 1 segundo.

maxWaitTimeInMs?: number

Valor de propiedad

number

onSendEventsErrorHandler

Controlador al que se llamará cuando un lote no se puede publicar.

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

Valor de propiedad

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

Controlador al que se llamará una vez que un lote se haya publicado correctamente.

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

Valor de propiedad

(ctx: OnSendEventsSuccessContext) => void

Detalles de las propiedades heredadas

customEndpointAddress

Un punto de conexión personalizado que se usará al conectarse al servicio Event Hubs. Esto puede ser útil cuando la red no permite conectarse a la dirección del punto de conexión de Azure Event Hubs estándar, pero permite conectarse a través de un intermediario.

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

customEndpointAddress?: string

Valor de propiedad

string

Heredado deEventHubClientOptions.customEndpointAddress

identifier

Un nombre único que se usa para identificar al cliente. Si no se proporciona, se usará un GUID como identificador.

identifier?: string

Valor de propiedad

string

Heredado deEventHubClientOptions.identifier

retryOptions

Opciones para configurar la directiva de reintentos para todas las operaciones del cliente. Por ejemplo, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Valor de propiedad

RetryOptions

Heredado deEventHubClientOptions.retryOptions

userAgent

Valor que se anexa a la cadena del agente de usuario integrada que se pasa al servicio Event Hubs.

userAgent?: string

Valor de propiedad

string

Heredado deEventHubClientOptions.userAgent

webSocketOptions

Opciones para configurar el canalización de la conexión AMQP a través de web Sockets.

webSocketOptions?: WebSocketOptions

Valor de propiedad

WebSocketOptions

Heredado deEventHubClientOptions.webSocketOptions