EventHubBufferedProducerClientOptions interface

Pacote:

@azure/event-hubs

Descreve as opções que podem ser fornecidas durante a criação do EventHubBufferedProducerClient.

Extends

EventHubClientOptions

Propriedades

enableIdempotentRetries	Indica se o EventHubProducerClient deve ou não habilitar a publicação idempotente em partições do Hub de Eventos. Se habilitado, o produtor só poderá publicar diretamente em partições; ele não poderá publicar no gateway de Hubs de Eventos para roteamento automático de partições 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	A quantidade de tempo para aguardar 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 não for publicado.
onSendEventsSuccessHandler	O manipulador a ser chamado assim que um lote for publicado com êxito.

Propriedades Herdadas

customEndpointAddress	Um ponto de extremidade personalizado para usar ao se conectar ao serviço Hubs de Eventos. Isso pode ser útil quando sua rede não permite a conexão com o endereço de ponto de extremidade padrão dos 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 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 é anexado à cadeia de caracteres interna do agente do usuário que é passada para o serviço Hubs de Eventos.
webSocketOptions	Opções para configurar a canalização da conexão AMQP através de Web Sockets.

Detalhes de Propriedade

enableIdempotentRetries

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

enableIdempotentRetries?: boolean

Valor de 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 de Propriedade

number

maxWaitTimeInMs

A quantidade de tempo para aguardar que um novo evento seja enfileirado no buffer antes de publicar um lote parcialmente completo.

Padrão: 1 segundo.

maxWaitTimeInMs?: number

Valor de Propriedade

number

onSendEventsErrorHandler

O manipulador a ser chamado quando um lote não for publicado.

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

Valor de Propriedade

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

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

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

Valor de Propriedade

(ctx: OnSendEventsSuccessContext) => void

Detalhes da Propriedade Herdada

customEndpointAddress

Um ponto de extremidade personalizado para usar ao se conectar ao serviço Hubs de Eventos. Isso pode ser útil quando sua rede não permite a conexão com o endereço de ponto de extremidade padrão dos 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 de Propriedade

string

herdado de EventHubClientOptions.customEndpointAddress

identifier

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

identifier?: string

Valor de Propriedade

string

herdado de EventHubClientOptions.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 de Propriedade

RetryOptions

herdado deEventHubClientOptions.retryOptions

userAgent

Valor que é anexado à cadeia de caracteres interna do agente do usuário que é passada para o serviço Hubs de Eventos.

userAgent?: string

Valor de Propriedade

string

herdado de EventHubClientOptions.userAgent

webSocketOptions

Opções para configurar a canalização da conexão AMQP através de Web Sockets.

webSocketOptions?: WebSocketOptions

Valor de Propriedade

WebSocketOptions

herdado deEventHubClientOptions.webSocketOptions