EventHubBufferedProducerClientOptions interface

Pakket:

@azure/event-hubs

Hierin worden de opties beschreven die kunnen worden opgegeven tijdens het maken van de EventHubBufferedProducerClient.

Uitbreiding

EventHubClientOptions

Eigenschappen

enableIdempotentRetries	Hiermee wordt aangegeven of de EventHubProducerClient idempotent-publicatie naar Event Hub-partities moet inschakelen. Als deze optie is ingeschakeld, kan de producent alleen rechtstreeks naar partities publiceren; het kan niet publiceren naar de Event Hubs-gateway voor automatische partitieroutering en kan ook geen partitiesleutel gebruiken. Standaardinstelling: false
maxEventBufferLengthPerPartition	Het totale aantal gebeurtenissen dat kan worden gebufferd voor publicatie op een bepaald moment voor een bepaalde partitie. Standaardinstelling: 1500
maxWaitTimeInMs	De hoeveelheid tijd die moet worden gewacht totdat een nieuwe gebeurtenis in de buffer wordt geplaatst voordat een gedeeltelijk volledige batch wordt gepubliceerd. Standaardinstelling: 1 seconde.
onSendEventsErrorHandler	De handler die moet worden aangeroepen wanneer een batch niet kan worden gepubliceerd.
onSendEventsSuccessHandler	De handler die moet worden aangeroepen zodra een batch is gepubliceerd.

Overgenomen eigenschappen

customEndpointAddress	Een aangepast eindpunt dat moet worden gebruikt om verbinding te maken met de Event Hubs-service. Dit kan handig zijn als uw netwerk geen verbinding met het standaardadres van het Azure Event Hubs-eindpunt toestaat, maar wel verbinding maakt via een tussenliggende instantie. Voorbeeld: "https://my.custom.endpoint:100/"
identifier	Een unieke naam die wordt gebruikt om de client te identificeren. Als deze niet wordt opgegeven, wordt een GUID gebruikt als de id
retryOptions	Opties voor het configureren van het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent	Waarde die wordt toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de Event Hubs-service.
webSocketOptions	Opties voor het configureren van de channeling van de AMQP-verbinding via websockets.

Eigenschapdetails

enableIdempotentRetries

Hiermee wordt aangegeven of de EventHubProducerClient idempotent-publicatie naar Event Hub-partities moet inschakelen. Als deze optie is ingeschakeld, kan de producent alleen rechtstreeks naar partities publiceren; het kan niet publiceren naar de Event Hubs-gateway voor automatische partitieroutering en kan ook geen partitiesleutel gebruiken. Standaardinstelling: false

enableIdempotentRetries?: boolean

Waarde van eigenschap

boolean

maxEventBufferLengthPerPartition

Het totale aantal gebeurtenissen dat kan worden gebufferd voor publicatie op een bepaald moment voor een bepaalde partitie.

Standaardinstelling: 1500

maxEventBufferLengthPerPartition?: number

Waarde van eigenschap

number

maxWaitTimeInMs

De hoeveelheid tijd die moet worden gewacht totdat een nieuwe gebeurtenis in de buffer wordt geplaatst voordat een gedeeltelijk volledige batch wordt gepubliceerd.

Standaardinstelling: 1 seconde.

maxWaitTimeInMs?: number

Waarde van eigenschap

number

onSendEventsErrorHandler

De handler die moet worden aangeroepen wanneer een batch niet kan worden gepubliceerd.

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

Waarde van eigenschap

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

De handler die moet worden aangeroepen zodra een batch is gepubliceerd.

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

Waarde van eigenschap

(ctx: OnSendEventsSuccessContext) => void

Details van overgenomen eigenschap

customEndpointAddress

Een aangepast eindpunt dat moet worden gebruikt om verbinding te maken met de Event Hubs-service. Dit kan handig zijn als uw netwerk geen verbinding met het standaardadres van het Azure Event Hubs-eindpunt toestaat, maar wel verbinding maakt via een tussenliggende instantie.

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

customEndpointAddress?: string

Waarde van eigenschap

string

Overgenomen vanEventHubClientOptions.customEndpointAddress

identifier

Een unieke naam die wordt gebruikt om de client te identificeren. Als deze niet wordt opgegeven, wordt een GUID gebruikt als de id

identifier?: string

Waarde van eigenschap

string

Overgenomen vanEventHubClientOptions.identifier

retryOptions

Opties voor het configureren van het beleid voor opnieuw proberen voor alle bewerkingen op de client. Bijvoorbeeld { "maxRetries": 4 } of { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Waarde van eigenschap

RetryOptions

Overgenomen vanEventHubClientOptions.retryOptions

userAgent

Waarde die wordt toegevoegd aan de ingebouwde tekenreeks van de gebruikersagent die wordt doorgegeven aan de Event Hubs-service.

userAgent?: string

Waarde van eigenschap

string

Overgenomen vanEventHubClientOptions.userAgent

webSocketOptions

Opties voor het configureren van de channeling van de AMQP-verbinding via websockets.

webSocketOptions?: WebSocketOptions

Waarde van eigenschap

WebSocketOptions

Overgenomen vanEventHubClientOptions.webSocketOptions