EventHubBufferedProducerClientOptions interface

Paket:

@azure/event-hubs

Beschreibt die Optionen, die beim Erstellen der EventHubBufferedProducerClientbereitgestellt werden können.

Extends

EventHubClientOptions

Eigenschaften

enableIdempotentRetries	Gibt an, ob der EventHubProducerClient die idempotent-Veröffentlichung in Event Hub-Partitionen aktivieren soll. Wenn diese Option aktiviert ist, kann der Produzent nur direkt auf Partitionen veröffentlichen; es kann nicht für das Event Hubs-Gateway für das automatische Partitionsrouting veröffentlicht werden, noch kann er einen Partitionsschlüssel verwenden. Standard: false
maxEventBufferLengthPerPartition	Die Gesamtanzahl der Ereignisse, die für die Veröffentlichung zu einem bestimmten Zeitpunkt für eine bestimmte Partition gepuffert werden können. Standard: 1500
maxWaitTimeInMs	Der Zeitaufwand, bis ein neues Ereignis im Puffer abgefragt wird, bevor ein teilweise vollständiger Batch veröffentlicht wird. Standard: 1 Sekunde.
onSendEventsErrorHandler	Der Handler, der aufgerufen werden soll, wenn ein Batch nicht veröffentlicht werden kann.
onSendEventsSuccessHandler	Der Handler, der aufgerufen werden soll, nachdem ein Batch erfolgreich veröffentlicht wurde.

Geerbte Eigenschaften

customEndpointAddress	Ein benutzerdefinierter Endpunkt, der beim Herstellen einer Verbindung mit dem Event Hubs-Dienst verwendet werden soll. Dies kann nützlich sein, wenn Ihr Netzwerk keine Verbindung mit der standardmäßigen Azure Event Hubs-Endpunktadresse zulässt, die Verbindung aber über einen Zwischenhändler ermöglicht. Beispiel: "https://my.custom.endpoint:100/"
identifier	Ein eindeutiger Name, der zum Identifizieren des Clients verwendet wird. Wenn nicht angegeben, wird eine GUID als Bezeichner verwendet.
retryOptions	Optionen zum Konfigurieren der Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Beispiel: { "maxRetries": 4 } oder { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent	Wert, der an die integrierte Benutzer-Agent-Zeichenfolge angefügt wird, die an den Event Hubs-Dienst übergeben wird.
webSocketOptions	Optionen zum Konfigurieren der Kanalierung der AMQP-Verbindung über Web Sockets.

Details zur Eigenschaft

enableIdempotentRetries

Gibt an, ob der EventHubProducerClient die idempotent-Veröffentlichung in Event Hub-Partitionen aktivieren soll. Wenn diese Option aktiviert ist, kann der Produzent nur direkt auf Partitionen veröffentlichen; es kann nicht für das Event Hubs-Gateway für das automatische Partitionsrouting veröffentlicht werden, noch kann er einen Partitionsschlüssel verwenden. Standard: false

enableIdempotentRetries?: boolean

Eigenschaftswert

boolean

maxEventBufferLengthPerPartition

Die Gesamtanzahl der Ereignisse, die für die Veröffentlichung zu einem bestimmten Zeitpunkt für eine bestimmte Partition gepuffert werden können.

Standard: 1500

maxEventBufferLengthPerPartition?: number

Eigenschaftswert

number

maxWaitTimeInMs

Der Zeitaufwand, bis ein neues Ereignis im Puffer abgefragt wird, bevor ein teilweise vollständiger Batch veröffentlicht wird.

Standard: 1 Sekunde.

maxWaitTimeInMs?: number

Eigenschaftswert

number

onSendEventsErrorHandler

Der Handler, der aufgerufen werden soll, wenn ein Batch nicht veröffentlicht werden kann.

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

Eigenschaftswert

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

Der Handler, der aufgerufen werden soll, nachdem ein Batch erfolgreich veröffentlicht wurde.

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

Eigenschaftswert

(ctx: OnSendEventsSuccessContext) => void

Geerbte Eigenschaftsdetails

customEndpointAddress

Ein benutzerdefinierter Endpunkt, der beim Herstellen einer Verbindung mit dem Event Hubs-Dienst verwendet werden soll. Dies kann nützlich sein, wenn Ihr Netzwerk keine Verbindung mit der standardmäßigen Azure Event Hubs-Endpunktadresse zulässt, die Verbindung aber über einen Zwischenhändler ermöglicht.

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

customEndpointAddress?: string

Eigenschaftswert

string

geerbt vonEventHubClientOptions.customEndpointAddress

identifier

Ein eindeutiger Name, der zum Identifizieren des Clients verwendet wird. Wenn nicht angegeben, wird eine GUID als Bezeichner verwendet.

identifier?: string

Eigenschaftswert

string

vonEventHubClientOptions.identifier geerbt

retryOptions

Optionen zum Konfigurieren der Wiederholungsrichtlinie für alle Vorgänge auf dem Client. Beispiel: { "maxRetries": 4 } oder { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Eigenschaftswert

RetryOptions

geerbt vonEventHubClientOptions.retryOptions

userAgent

Wert, der an die integrierte Benutzer-Agent-Zeichenfolge angefügt wird, die an den Event Hubs-Dienst übergeben wird.

userAgent?: string

Eigenschaftswert

string

geerbt vonEventHubClientOptions.userAgent-

webSocketOptions

Optionen zum Konfigurieren der Kanalierung der AMQP-Verbindung über Web Sockets.

webSocketOptions?: WebSocketOptions

Eigenschaftswert

WebSocketOptions

vonEventHubClientOptions.webSocketOptions