ServiceBusMessageBatch Classe

Lot de messages.

L’envoi de messages dans un lot est plus performant que l’envoi de messages individuels. ServiceBusMessageBatch vous aide à créer le lot de taille maximale autorisée de Message pour améliorer les performances d’envoi.

Utilisez la méthode add pour ajouter des messages jusqu’à ce que la limite de taille de lot maximale en octets ait été atteinte, à partir de laquelle un MessageSizeExceededError sera déclenché.

Utilisez la méthode create_message_batch de ServiceBusSender pour créer un objet ServiceBusMessageBatch au lieu d’instancier un objet ServiceBusMessageBatch directement.

Héritage

builtins.object

ServiceBusMessageBatch

Constructeur

ServiceBusMessageBatch(max_size_in_bytes: int | None = None, **kwargs: Any)

Paramètres

Nom	Description
max_size_in_bytes	Optional[int] Taille maximale des données octets qu’un objet ServiceBusMessageBatch peut contenir. valeur par défaut: None

Méthodes

add_message

Essayez d’ajouter un seul message au lot. La taille totale d’un message ajouté est la somme de son corps, de ses propriétés, etc. Si cette taille ajoutée entraîne le dépassement de la taille maximale du lot, un message MessageSizeExceededError est déclenché.

add_message

Essayez d’ajouter un seul message au lot.

La taille totale d’un message ajouté est la somme de son corps, de ses propriétés, etc. Si cette taille ajoutée entraîne le dépassement de la taille maximale du lot, un message MessageSizeExceededError est déclenché.

add_message(message: ServiceBusMessage | AmqpAnnotatedMessage | Mapping[str, Any]) -> None

Paramètres

Nom	Description
message Obligatoire	Union[ServiceBusMessage, AmqpAnnotatedMessage] Message à ajouter au lot.

Exceptions

Type	Description
<xref:azure.servicebus.exceptions.MessageSizeExceededError>, <xref:when exceeding the size limit.>

Attributs

max_size_in_bytes

Taille maximale des données octets qu’un objet ServiceBusMessageBatch peut contenir.

Retours

Type	Description
int

message

Obtenez l’uamqp sous-jacent. BatchMessage ou LegacyBatchMessage. Cette option est déconseillée et sera supprimée dans une version ultérieure.

Retours

Type	Description
<xref:uamqp.BatchMessage>, <xref:LegacyBatchMessage>

size_in_bytes

Taille combinée des messages du lot, en octets.

Retours

Type	Description
int