Condividi tramite

EventHubBufferedProducerClientOptions interface

  • Riferimento
Pacchetto:
@azure/event-hubs

Vengono descritte le opzioni che è possibile specificare durante la creazione del EventHubBufferedProducerClient.

Extends
EventHubClientOptions

Proprietà

enableIdempotentRetries

Indica se EventHubProducerClient deve abilitare la pubblicazione idempotente nelle partizioni dell'hub eventi. Se abilitata, il producer sarà in grado di pubblicare direttamente nelle partizioni; non sarà in grado di pubblicare nel gateway di Hub eventi per il routing automatico delle partizioni né sarà in grado di usare una chiave di partizione. Impostazione predefinita: false
maxEventBufferLengthPerPartition

Numero totale di eventi che possono essere memorizzati nel buffer per la pubblicazione in un determinato momento per una determinata partizione.

Impostazione predefinita: 1500
maxWaitTimeInMs

Quantità di tempo di attesa per l'accodamento di un nuovo evento nel buffer prima di pubblicare un batch parzialmente completo.

Impostazione predefinita: 1 secondo.
onSendEventsErrorHandler

Gestore da chiamare quando un batch non riesce a pubblicare.
onSendEventsSuccessHandler

Gestore da chiamare dopo che un batch è stato pubblicato correttamente.

Proprietà ereditate

customEndpointAddress

Endpoint personalizzato da usare per la connessione al servizio Hub eventi. Ciò può essere utile quando la rete non consente la connessione all'indirizzo dell'endpoint di Hub eventi di Azure standard, ma consente la connessione tramite un intermediario.

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

Nome univoco utilizzato per identificare il client. Se non specificato, un GUID verrà usato come identificatore
retryOptions

Opzioni per configurare i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Valore aggiunto alla stringa dell'agente utente predefinita passata al servizio Hub eventi.
webSocketOptions

Opzioni per configurare il canale della connessione AMQP tramite Web Socket.

Dettagli proprietà

enableIdempotentRetries

Indica se EventHubProducerClient deve abilitare la pubblicazione idempotente nelle partizioni dell'hub eventi. Se abilitata, il producer sarà in grado di pubblicare direttamente nelle partizioni; non sarà in grado di pubblicare nel gateway di Hub eventi per il routing automatico delle partizioni né sarà in grado di usare una chiave di partizione. Impostazione predefinita: false

enableIdempotentRetries?: boolean

Valore della proprietà

boolean

maxEventBufferLengthPerPartition

Numero totale di eventi che possono essere memorizzati nel buffer per la pubblicazione in un determinato momento per una determinata partizione.

Impostazione predefinita: 1500

maxEventBufferLengthPerPartition?: number

Valore della proprietà

number

maxWaitTimeInMs

Quantità di tempo di attesa per l'accodamento di un nuovo evento nel buffer prima di pubblicare un batch parzialmente completo.

Impostazione predefinita: 1 secondo.

maxWaitTimeInMs?: number

Valore della proprietà

number

onSendEventsErrorHandler

Gestore da chiamare quando un batch non riesce a pubblicare.

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

Valore della proprietà

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

Gestore da chiamare dopo che un batch è stato pubblicato correttamente.

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

Valore della proprietà

(ctx: OnSendEventsSuccessContext) => void

Dettagli proprietà ereditate

customEndpointAddress

Endpoint personalizzato da usare per la connessione al servizio Hub eventi. Ciò può essere utile quando la rete non consente la connessione all'indirizzo dell'endpoint di Hub eventi di Azure standard, ma consente la connessione tramite un intermediario.

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

customEndpointAddress?: string

Valore della proprietà

string

Ereditato daEventHubClientOptions.customEndpointAddress

identifier

Nome univoco utilizzato per identificare il client. Se non specificato, un GUID verrà usato come identificatore

identifier?: string

Valore della proprietà

string

ereditato daEventHubClientOptions.identifier

retryOptions

Opzioni per configurare i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Valore della proprietà

RetryOptions

ereditato daEventHubClientOptions.retryOptions

userAgent

Valore aggiunto alla stringa dell'agente utente predefinita passata al servizio Hub eventi.

userAgent?: string

Valore della proprietà

string

Ereditato daEventHubClientOptions.userAgent

webSocketOptions

Opzioni per configurare il canale della connessione AMQP tramite Web Socket.

webSocketOptions?: WebSocketOptions

Valore della proprietà

WebSocketOptions

ereditato daEventHubClientOptions.webSocketOptions