ServiceBusMessageBatch Klasa

Partia komunikatów.

Wysyłanie komunikatów w partii jest bardziej wydajne niż wysyłanie pojedynczej wiadomości. Usługa ServiceBusMessageBatch pomaga utworzyć maksymalną dozwoloną partię komunikatów w celu zwiększenia wydajności wysyłania.

Użyj metody add , aby dodać komunikaty do momentu osiągnięcia maksymalnego limitu rozmiaru partii w bajtach — w którym momencie zostanie podniesiony błąd MessageSizeExceededError .

Użyj create_message_batch metody ServiceBusSender, aby utworzyć obiekt ServiceBusMessageBatch zamiast utworzyć wystąpienie obiektu ServiceBusMessageBatch bezpośrednio.

Dziedziczenie
builtins.object
ServiceBusMessageBatch

Konstruktor

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

Parametry

Nazwa Opis
max_size_in_bytes

Maksymalny rozmiar danych bajtów, które może przechowywać obiekt ServiceBusMessageBatch.

wartość domyślna: None

Metody

add_message

Spróbuj dodać pojedynczy komunikat do partii.

Całkowity rozmiar dodanego komunikatu to suma jego treści, właściwości itp. Jeśli ten dodany rozmiar spowoduje przekroczenie maksymalnego rozmiaru partii, zostanie zgłoszony błąd MessageSizeExceededError .

add_message

Spróbuj dodać pojedynczy komunikat do partii.

Całkowity rozmiar dodanego komunikatu to suma jego treści, właściwości itp. Jeśli ten dodany rozmiar spowoduje przekroczenie maksymalnego rozmiaru partii, zostanie zgłoszony błąd MessageSizeExceededError .

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

Parametry

Nazwa Opis
message
Wymagane

Komunikat do dodania do partii.

Wyjątki

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

Atrybuty

max_size_in_bytes

Maksymalny rozmiar danych bajtów, które może przechowywać obiekt ServiceBusMessageBatch.

Zwraca

Typ Opis
int

message

Pobierz podstawowy uamqp. BatchMessage lub LegacyBatchMessage. Jest to przestarzałe i zostanie usunięte w nowszej wersji.

Zwraca

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

size_in_bytes

Łączny rozmiar komunikatów w partii w bajtach.

Zwraca

Typ Opis
int