Share via

ServiceBusMessageBatch Klass

  • Referens

En batch med meddelanden.

Det är bättre att skicka meddelanden i en batch än att skicka enskilda meddelanden. ServiceBusMessageBatch hjälper dig att skapa den högsta tillåtna storleken på meddelande för att förbättra sändningsprestandan.

Använd metoden lägg till för att lägga till meddelanden tills den maximala gränsen för batchstorlek i byte har uppnåtts. Då aktiveras messageSizeExceededError .

Använd create_message_batch-metoden för ServiceBusSender för att skapa ett ServiceBusMessageBatch-objekt i stället för att instansiera ett ServiceBusMessageBatch-objekt direkt.

Arv
builtins.object
ServiceBusMessageBatch

Konstruktor

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

Parametrar

Name Description
max_size_in_bytes
Optional[int]

Den maximala storleken på bytedata som ett ServiceBusMessageBatch-objekt kan innehålla.

standardvärde: None

Metoder

add_message

Försök att lägga till ett enda meddelande i batchen.

Den totala storleken på ett tillagt meddelande är summan av dess brödtext, egenskaper osv. Om den här extra storleken resulterar i att batchen överskrider den maximala batchstorleken utlöses en MessageSizeExceededError .

add_message

Försök att lägga till ett enda meddelande i batchen.

Den totala storleken på ett tillagt meddelande är summan av dess brödtext, egenskaper osv. Om den här extra storleken resulterar i att batchen överskrider den maximala batchstorleken utlöses en MessageSizeExceededError .

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

Parametrar

Name Description
message
Obligatorisk
Union[ServiceBusMessage, AmqpAnnotatedMessage]

Meddelandet som ska läggas till i batchen.

Undantag

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

Attribut

max_size_in_bytes

Den maximala storleken på bytedata som ett ServiceBusMessageBatch-objekt kan innehålla.

Returer

Typ Description
int

message

Hämta den underliggande uamqp. BatchMessage eller LegacyBatchMessage. Detta är inaktuellt och tas bort i en senare version.

Returer

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

size_in_bytes

Den kombinerade storleken på meddelandena i batchen, i byte.

Returer

Typ Description
int