EventHubBufferedProducerClientOptions interface

Pacote:

@azure/event-hubs

Descreve as opções que podem ser fornecidas ao criar o EventHubBufferedProducerClient.

Extends

EventHubClientOptions

Propriedades

enableIdempotentRetries	Indica se o EventHubProducerClient deve ou não habilitar a publicação idempotente nas partições do Hub de Eventos. Se habilitado, o produtor só poderá publicar diretamente em partições; ele não poderá publicar no gateway dos Hubs de Eventos para roteamento automático de partição nem poderá usar uma chave de partição. Padrão: false
maxEventBufferLengthPerPartition	O número total de eventos que podem ser armazenados em buffer para publicação em um determinado momento para uma determinada partição. Padrão: 1500
maxWaitTimeInMs	O tempo de espera para que um novo evento seja enfileirado no buffer antes de publicar um lote parcialmente completo. Padrão: 1 segundo.
onSendEventsErrorHandler	O manipulador a ser chamado quando um lote falha ao publicar.
onSendEventsSuccessHandler	O manipulador a ser chamado depois que um lote for publicado com êxito.

Propriedades herdadas

customEndpointAddress	Um ponto de extremidade personalizado a ser usado ao se conectar ao serviço de Hubs de Eventos. Isso pode ser útil quando sua rede não permite a conexão com o endereço padrão do ponto de extremidade Hubs de Eventos do Azure, mas permite a conexão por meio de um intermediário. Exemplo: "https://my.custom.endpoint:100/"
identifier	Um nome exclusivo usado para identificar o cliente. Se não for fornecido, um GUID será usado como o identificador
retryOptions	Opções para configurar a política de repetição para todas as operações no cliente. Por exemplo, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent	Valor que é acrescentado à cadeia de caracteres interna do agente de usuário que é passada para o serviço hubs de eventos.
webSocketOptions	Opções para configurar o canal da conexão AMQP por meio de Web Sockets.

Detalhes da propriedade

enableIdempotentRetries

Indica se o EventHubProducerClient deve ou não habilitar a publicação idempotente nas partições do Hub de Eventos. Se habilitado, o produtor só poderá publicar diretamente em partições; ele não poderá publicar no gateway dos Hubs de Eventos para roteamento automático de partição nem poderá usar uma chave de partição. Padrão: false

enableIdempotentRetries?: boolean

Valor da propriedade

boolean

maxEventBufferLengthPerPartition

O número total de eventos que podem ser armazenados em buffer para publicação em um determinado momento para uma determinada partição.

Padrão: 1500

maxEventBufferLengthPerPartition?: number

Valor da propriedade

number

maxWaitTimeInMs

O tempo de espera para que um novo evento seja enfileirado no buffer antes de publicar um lote parcialmente completo.

Padrão: 1 segundo.

maxWaitTimeInMs?: number

Valor da propriedade

number

onSendEventsErrorHandler

O manipulador a ser chamado quando um lote falha ao publicar.

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

Valor da propriedade

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

O manipulador a ser chamado depois que um lote for publicado com êxito.

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

Valor da propriedade

(ctx: OnSendEventsSuccessContext) => void

Detalhes das propriedades herdadas

customEndpointAddress

Um ponto de extremidade personalizado a ser usado ao se conectar ao serviço de Hubs de Eventos. Isso pode ser útil quando sua rede não permite a conexão com o endereço padrão do ponto de extremidade Hubs de Eventos do Azure, mas permite a conexão por meio de um intermediário.

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

customEndpointAddress?: string

Valor da propriedade

string

Herdado deEventHubClientOptions.customEndpointAddress

identifier

Um nome exclusivo usado para identificar o cliente. Se não for fornecido, um GUID será usado como o identificador

identifier?: string

Valor da propriedade

string

Herdado deEventHubClientOptions.identifier

retryOptions

Opções para configurar a política de repetição para todas as operações no cliente. Por exemplo, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Valor da propriedade

RetryOptions

Herdado deEventHubClientOptions.retryOptions

userAgent

Valor que é acrescentado à cadeia de caracteres interna do agente de usuário que é passada para o serviço hubs de eventos.

userAgent?: string

Valor da propriedade

string

Herdado deEventHubClientOptions.userAgent

webSocketOptions

Opções para configurar o canal da conexão AMQP por meio de Web Sockets.

webSocketOptions?: WebSocketOptions

Valor da propriedade

WebSocketOptions

Herdado deEventHubClientOptions.webSocketOptions