EventDataBatch interface

Paquet:

@azure/event-hubs

Interface représentant un lot d’événements qui peut être utilisé pour envoyer des événements à Event Hub.

Pour créer le lot, utilisez la createBatch() méthode sur le EventHubProducerClient. Pour envoyer le lot, utilisez la sendBatch() méthode sur le même client. Pour remplir le lot, utilisez la tryAdd() méthode sur le lot lui-même.

Propriétés

count	Nombre d’événements ajoutés au lot.
maxSizeInBytes	Taille maximale du lot, en octets. La tryAdd fonction sur le lot retourne false si l’événement ajouté fait que la taille du lot dépasse cette limite. Utilisez la createBatch() méthode sur pour EventHubProducerClient définir le maxSizeInBytes.
sizeInBytes	Taille du lot en octets une fois que les événements qui lui ont été ajoutés ont été encodés dans un seul message AMQP.

Méthodes

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Ajoute un événement au lot si la limite de taille du lot l’autorise. REMARQUE : n’oubliez pas toujours de vérifier la valeur de retour de cette méthode avant de l’appeler à nouveau pour l’événement suivant.

Détails de la propriété

count

Nombre d’événements ajoutés au lot.

count: number

Valeur de propriété

number

maxSizeInBytes

Taille maximale du lot, en octets. La tryAdd fonction sur le lot retourne false si l’événement ajouté fait que la taille du lot dépasse cette limite. Utilisez la createBatch() méthode sur pour EventHubProducerClient définir le maxSizeInBytes.

maxSizeInBytes: number

Valeur de propriété

number

sizeInBytes

Taille du lot en octets une fois que les événements qui lui ont été ajoutés ont été encodés dans un seul message AMQP.

sizeInBytes: number

Valeur de propriété

number

Détails de la méthode

tryAdd(EventData | AmqpAnnotatedMessage, TryAddOptions)

Ajoute un événement au lot si la limite de taille du lot l’autorise. REMARQUE : n’oubliez pas toujours de vérifier la valeur de retour de cette méthode avant de l’appeler à nouveau pour l’événement suivant.

function tryAdd(eventData: EventData | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

Paramètres

eventData

EventData | AmqpAnnotatedMessage

Objet de données d’événement individuel ou AmqpAnnotatedMessage.

options

TryAddOptions

Retours

boolean

Valeur booléenne indiquant si les données d’événement ont été ajoutées au lot ou non.