SubscribeOptions interface

Paquet:

@azure/event-hubs

Options de configuration de la subscribe méthode sur le EventHubConsumerClient. Par exemple : { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Propriétés

maxBatchSize	Nombre d’événements à demander par lot
maxWaitTimeInSeconds	Durée maximale d’attente pour générer le nombre de messages demandés avant de transmettre les données au code utilisateur pour traitement. S’il n’est pas fourni, la valeur par défaut est de 60 secondes.
ownerLevel	Niveau propriétaire à utiliser comme abonnement s’abonne aux partitions.
prefetchCount	Nombre d’événements demandés avec hâte et mis en file d’attente, sans tenir compte de la demande de lecture ou non.
skipParsingBodyAsJson	Option permettant de désactiver le client d’exécuter JSON.parse() sur le corps du message lors de la réception du message. Non applicable si le message a été envoyé avec une valeur ou une séquence de type de corps AMQP. Utilisez cette option lorsque vous préférez travailler directement avec les octets présents dans le corps du message plutôt que d’avoir le client à tenter de l’analyser.
startPosition	Position de l’événement dans une partition à partir de laquelle commencer à recevoir des événements à partir de si aucun point de contrôle n’est trouvé. Passez une carte de l’ID de partition à la position si vous souhaitez utiliser une position de départ différente pour chaque partition.
tracingOptions	Options de configuration du suivi.
trackLastEnqueuedEventProperties	Indique si le consommateur doit demander des informations sur le dernier événement mis en file d’attente sur sa partition associée et suivre ces informations à mesure que les événements sont reçus. Lorsque des informations sur le dernier événement mis en file d’attente de la partition sont suivies, chaque événement reçu du service Event Hubs contient des métadonnées sur la partition qu’il ne serait pas autrement. Il en résulte une petite quantité de bande passante réseau supplémentaire qui est généralement un compromis favorable lorsqu’il est considéré par rapport à l’envoi périodique de demandes de propriétés de partition à l’aide du client Event Hub.

Détails de la propriété

maxBatchSize

Nombre d’événements à demander par lot

maxBatchSize?: number

Valeur de propriété

number

maxWaitTimeInSeconds

Durée maximale d’attente pour générer le nombre de messages demandés avant de transmettre les données au code utilisateur pour traitement. S’il n’est pas fourni, la valeur par défaut est de 60 secondes.

maxWaitTimeInSeconds?: number

Valeur de propriété

number

ownerLevel

Niveau propriétaire à utiliser comme abonnement s’abonne aux partitions.

ownerLevel?: number

Valeur de propriété

number

prefetchCount

Nombre d’événements demandés avec hâte et mis en file d’attente, sans tenir compte de la demande de lecture ou non.

prefetchCount?: number

Valeur de propriété

number

skipParsingBodyAsJson

Option permettant de désactiver le client d’exécuter JSON.parse() sur le corps du message lors de la réception du message. Non applicable si le message a été envoyé avec une valeur ou une séquence de type de corps AMQP. Utilisez cette option lorsque vous préférez travailler directement avec les octets présents dans le corps du message plutôt que d’avoir le client à tenter de l’analyser.

skipParsingBodyAsJson?: boolean

Valeur de propriété

boolean

startPosition

Position de l’événement dans une partition à partir de laquelle commencer à recevoir des événements à partir de si aucun point de contrôle n’est trouvé. Passez une carte de l’ID de partition à la position si vous souhaitez utiliser une position de départ différente pour chaque partition.

startPosition?: EventPosition | {[partitionId: string]: EventPosition}

Valeur de propriété

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Options de configuration du suivi.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

trackLastEnqueuedEventProperties

Indique si le consommateur doit demander des informations sur le dernier événement mis en file d’attente sur sa partition associée et suivre ces informations à mesure que les événements sont reçus.

Lorsque des informations sur le dernier événement mis en file d’attente de la partition sont suivies, chaque événement reçu du service Event Hubs contient des métadonnées sur la partition qu’il ne serait pas autrement. Il en résulte une petite quantité de bande passante réseau supplémentaire qui est généralement un compromis favorable lorsqu’il est considéré par rapport à l’envoi périodique de demandes de propriétés de partition à l’aide du client Event Hub.

trackLastEnqueuedEventProperties?: boolean

Valeur de propriété

boolean