Partager via


ServiceBusMessageBatch interface

Lot de messages que vous pouvez créer à l’aide de la <xref:createBatch> méthode .

Propriétés

count

Nombre de messages ajoutés au lot.

maxSizeInBytes

Taille maximale du lot, en octets. La tryAddMessage fonction sur le lot retourne false si le message ajouté entraîne le dépassement de la taille du lot. Utilisez la createMessageBatch() méthode sur pour Sender 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

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Ajoute un message 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 de messages ajoutés au lot.

count: number

Valeur de propriété

number

maxSizeInBytes

Taille maximale du lot, en octets. La tryAddMessage fonction sur le lot retourne false si le message ajouté entraîne le dépassement de la taille du lot. Utilisez la createMessageBatch() méthode sur pour Sender 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

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Ajoute un message 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 tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

Paramètres

message

ServiceBusMessage | AmqpAnnotatedMessage

Message à ajouter au lot.

options
TryAddOptions

Retours

boolean

Valeur booléenne indiquant si le message a été ajouté au lot ou non.