EventHubBufferedProducerClientOptions interface
Opisuje opcje, które można udostępnić podczas tworzenia EventHubBufferedProducerClient
.
- Rozszerzenie
Właściwości
enable |
Wskazuje, czy element EventHubProducerClient powinien włączyć publikowanie idempotentne w partycjach centrum zdarzeń. Jeśli to ustawienie jest włączone, producent będzie mógł publikować tylko bezpośrednio w partycjach; Nie będzie on mógł publikować w bramie usługi Event Hubs na potrzeby automatycznego routingu partycji ani nie będzie mógł użyć klucza partycji. Ustawienie domyślne: false |
max |
Łączna liczba zdarzeń, które można buforować do publikowania w danym momencie dla danej partycji. Ustawienie domyślne: 1500 |
max |
Czas oczekiwania na kolejkowanie nowego zdarzenia w buforze przed opublikowaniem częściowej pełnej partii. Wartość domyślna: 1 sekunda. |
on |
Procedura obsługi do wywołania, gdy nie można opublikować partii. |
on |
Procedura obsługi do wywołania po pomyślnym opublikowaniu partii. |
Właściwości dziedziczone
custom |
Niestandardowy punkt końcowy używany podczas nawiązywania połączenia z usługą Event Hubs. Może to być przydatne, gdy sieć nie zezwala na nawiązywanie połączenia ze standardowym adresem punktu końcowego usługi Azure Event Hubs, ale umożliwia nawiązywanie połączenia za pośrednictwem pośrednika. Przykład: "https://my.custom.endpoint:100/" |
identifier | Unikatowa nazwa używana do identyfikowania klienta. Jeśli nie zostanie podany, identyfikator GUID będzie używany jako identyfikator |
retry |
Opcje konfigurowania zasad ponawiania dla wszystkich operacji na kliencie.
Na przykład |
user |
Wartość dołączona do wbudowanego ciągu agenta użytkownika przekazanego do usługi Event Hubs. |
web |
Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd sieci Web. |
Szczegóły właściwości
enableIdempotentRetries
Wskazuje, czy element EventHubProducerClient powinien włączyć publikowanie idempotentne w partycjach centrum zdarzeń. Jeśli to ustawienie jest włączone, producent będzie mógł publikować tylko bezpośrednio w partycjach; Nie będzie on mógł publikować w bramie usługi Event Hubs na potrzeby automatycznego routingu partycji ani nie będzie mógł użyć klucza partycji. Ustawienie domyślne: false
enableIdempotentRetries?: boolean
Wartość właściwości
boolean
maxEventBufferLengthPerPartition
Łączna liczba zdarzeń, które można buforować do publikowania w danym momencie dla danej partycji.
Ustawienie domyślne: 1500
maxEventBufferLengthPerPartition?: number
Wartość właściwości
number
maxWaitTimeInMs
Czas oczekiwania na kolejkowanie nowego zdarzenia w buforze przed opublikowaniem częściowej pełnej partii.
Wartość domyślna: 1 sekunda.
maxWaitTimeInMs?: number
Wartość właściwości
number
onSendEventsErrorHandler
Procedura obsługi do wywołania, gdy nie można opublikować partii.
onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void
Wartość właściwości
(ctx: OnSendEventsErrorContext) => void
onSendEventsSuccessHandler
Procedura obsługi do wywołania po pomyślnym opublikowaniu partii.
onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void
Wartość właściwości
(ctx: OnSendEventsSuccessContext) => void
Szczegóły właściwości dziedziczonej
customEndpointAddress
Niestandardowy punkt końcowy używany podczas nawiązywania połączenia z usługą Event Hubs. Może to być przydatne, gdy sieć nie zezwala na nawiązywanie połączenia ze standardowym adresem punktu końcowego usługi Azure Event Hubs, ale umożliwia nawiązywanie połączenia za pośrednictwem pośrednika.
Przykład: "https://my.custom.endpoint:100/"
customEndpointAddress?: string
Wartość właściwości
string
dziedziczone zEventHubClientOptions.customEndpointAddress
identifier
Unikatowa nazwa używana do identyfikowania klienta. Jeśli nie zostanie podany, identyfikator GUID będzie używany jako identyfikator
identifier?: string
Wartość właściwości
string
dziedziczone zEventHubClientOptions.identifier
retryOptions
Opcje konfigurowania zasad ponawiania dla wszystkich operacji na kliencie.
Na przykład { "maxRetries": 4 }
lub { "maxRetries": 4, "retryDelayInMs": 30000 }
.
retryOptions?: RetryOptions
Wartość właściwości
dziedziczone zEventHubClientOptions.retryOptions
userAgent
Wartość dołączona do wbudowanego ciągu agenta użytkownika przekazanego do usługi Event Hubs.
userAgent?: string
Wartość właściwości
string
dziedziczone zEventHubClientOptions.userAgent
webSocketOptions
Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd sieci Web.
webSocketOptions?: WebSocketOptions
Wartość właściwości
dziedziczone zEventHubClientOptions.webSocketOptions