ServiceBusMessageBatch Klasse

Ein Batch von Nachrichten.

Das Senden von Nachrichten in einem Batch ist leistungsfähiger als das Senden einzelner Nachrichten. ServiceBusMessageBatch hilft Ihnen beim Erstellen des maximal zulässigen Nachrichtenbatches , um die Sendeleistung zu verbessern.

Verwenden Sie die add-Methode , um Nachrichten hinzuzufügen, bis die maximale Batchgröße in Byte erreicht wurde . An diesem Punkt wird ein MessageSizeExceededError ausgelöst.

Verwenden Sie die create_message_batch Methode von ServiceBusSender, um ein ServiceBusMessageBatch-Objekt zu erstellen, anstatt ein ServiceBusMessageBatch-Objekt direkt zu instanziieren.

Vererbung

builtins.object

ServiceBusMessageBatch

Konstruktor

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

Parameter

Name	Beschreibung
max_size_in_bytes	Optional[int] Die maximale Größe von Bytesdaten, die ein ServiceBusMessageBatch-Objekt enthalten kann. Standardwert: None

Methoden

add_message

Versuchen Sie, dem Batch eine einzelne Nachricht hinzuzufügen. Die Gesamtgröße einer hinzugefügten Nachricht ist die Summe ihres Textkörpers, ihrer Eigenschaften usw. Wenn diese hinzugefügte Größe dazu führt, dass der Batch die maximale Batchgröße überschreitet, wird ein MessageSizeExceededError ausgelöst.

add_message

Versuchen Sie, dem Batch eine einzelne Nachricht hinzuzufügen.

Die Gesamtgröße einer hinzugefügten Nachricht ist die Summe ihres Textkörpers, ihrer Eigenschaften usw. Wenn diese hinzugefügte Größe dazu führt, dass der Batch die maximale Batchgröße überschreitet, wird ein MessageSizeExceededError ausgelöst.

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

Parameter

Name	Beschreibung
message Erforderlich	Union[ServiceBusMessage, AmqpAnnotatedMessage] Die Nachricht, die dem Batch hinzugefügt werden soll.

Ausnahmen

Typ	Beschreibung
<xref:azure.servicebus.exceptions.MessageSizeExceededError>, <xref:when exceeding the size limit.>

Attribute

max_size_in_bytes

Die maximale Größe von Bytesdaten, die ein ServiceBusMessageBatch-Objekt enthalten kann.

Gibt zurück

Typ	Beschreibung
int

message

Rufen Sie die zugrunde liegende uamqp ab. BatchMessage oder LegacyBatchMessage. Dies ist veraltet und wird in einer späteren Version entfernt.

Gibt zurück

Typ	Beschreibung
<xref:uamqp.BatchMessage>, <xref:LegacyBatchMessage>

size_in_bytes

Die kombinierte Größe der Nachrichten im Batch in Bytes.

Gibt zurück

Typ	Beschreibung
int