Partager via

EventHubBufferedProducerClientOptions interface

  • Référence
Paquet:
@azure/event-hubs

Décrit les options qui peuvent être fournies lors de la création de .EventHubBufferedProducerClient

Extends
EventHubClientOptions

Propriétés

enableIdempotentRetries

Indique si EventHubProducerClient doit activer la publication idempotente sur les partitions Event Hub. Si cette option est activée, le producteur ne peut publier que directement sur les partitions ; il ne sera pas en mesure de publier sur la passerelle Event Hubs pour le routage de partition automatique, ni d’utiliser une clé de partition. Par défaut : false
maxEventBufferLengthPerPartition

Nombre total d’événements qui peuvent être mis en mémoire tampon pour la publication à un moment donné pour une partition donnée.

Valeur par défaut : 1500
maxWaitTimeInMs

Délai d’attente avant qu’un nouvel événement soit mis en file d’attente dans la mémoire tampon avant de publier un lot partiellement complet.

Valeur par défaut : 1 seconde.
onSendEventsErrorHandler

Gestionnaire à appeler lorsqu’un lot ne parvient pas à publier.
onSendEventsSuccessHandler

Gestionnaire à appeler une fois qu’un lot a été publié avec succès.

Propriétés héritées

customEndpointAddress

Point de terminaison personnalisé à utiliser lors de la connexion au service Event Hubs. Cela peut être utile lorsque votre réseau n’autorise pas la connexion à l’adresse de point de terminaison standard Azure Event Hubs, mais autorise la connexion via un intermédiaire.

Exemple : «https://my.custom.endpoint:100/" ;
identifier

Nom unique utilisé pour identifier le client. S’il n’est pas fourni, un GUID sera utilisé comme identificateur
retryOptions

Options permettant de configurer la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.
userAgent

Valeur ajoutée à la chaîne d’agent utilisateur intégrée qui est passée au service Event Hubs.
webSocketOptions

Options permettant de configurer le canal de la connexion AMQP sur des sockets web.

Détails de la propriété

enableIdempotentRetries

Indique si EventHubProducerClient doit activer la publication idempotente sur les partitions Event Hub. Si cette option est activée, le producteur ne peut publier que directement sur les partitions ; il ne sera pas en mesure de publier sur la passerelle Event Hubs pour le routage de partition automatique, ni d’utiliser une clé de partition. Par défaut : false

enableIdempotentRetries?: boolean

Valeur de propriété

boolean

maxEventBufferLengthPerPartition

Nombre total d’événements qui peuvent être mis en mémoire tampon pour la publication à un moment donné pour une partition donnée.

Valeur par défaut : 1500

maxEventBufferLengthPerPartition?: number

Valeur de propriété

number

maxWaitTimeInMs

Délai d’attente avant qu’un nouvel événement soit mis en file d’attente dans la mémoire tampon avant de publier un lot partiellement complet.

Valeur par défaut : 1 seconde.

maxWaitTimeInMs?: number

Valeur de propriété

number

onSendEventsErrorHandler

Gestionnaire à appeler lorsqu’un lot ne parvient pas à publier.

onSendEventsErrorHandler: (ctx: OnSendEventsErrorContext) => void

Valeur de propriété

(ctx: OnSendEventsErrorContext) => void

onSendEventsSuccessHandler

Gestionnaire à appeler une fois qu’un lot a été publié avec succès.

onSendEventsSuccessHandler?: (ctx: OnSendEventsSuccessContext) => void

Valeur de propriété

(ctx: OnSendEventsSuccessContext) => void

Détails de la propriété héritée

customEndpointAddress

Point de terminaison personnalisé à utiliser lors de la connexion au service Event Hubs. Cela peut être utile lorsque votre réseau n’autorise pas la connexion à l’adresse de point de terminaison standard Azure Event Hubs, mais autorise la connexion via un intermédiaire.

Exemple : «https://my.custom.endpoint:100/" ;

customEndpointAddress?: string

Valeur de propriété

string

Hérité deEventHubClientOptions.customEndpointAddress

identifier

Nom unique utilisé pour identifier le client. S’il n’est pas fourni, un GUID sera utilisé comme identificateur

identifier?: string

Valeur de propriété

string

Hérité deEventHubClientOptions.identifier

retryOptions

Options permettant de configurer la stratégie de nouvelle tentative pour toutes les opérations sur le client. Par exemple, { "maxRetries": 4 } ou { "maxRetries": 4, "retryDelayInMs": 30000 }.

retryOptions?: RetryOptions

Valeur de propriété

RetryOptions

Héritéd’EventHubClientOptions.retryOptions

userAgent

Valeur ajoutée à la chaîne d’agent utilisateur intégrée qui est passée au service Event Hubs.

userAgent?: string

Valeur de propriété

string

Héritéd’EventHubClientOptions.userAgent

webSocketOptions

Options permettant de configurer le canal de la connexion AMQP sur des sockets web.

webSocketOptions?: WebSocketOptions

Valeur de propriété

WebSocketOptions

Héritéd’EventHubClientOptions.webSocketOptions