ServiceBusMessageBatch Classe
Um lote de mensagens.
O envio de mensagens em um lote é mais eficaz do que o envio de mensagens individuais. ServiceBusMessageBatch ajuda você a criar o lote de tamanho máximo permitido de Mensagem para melhorar o desempenho de envio.
Use o método add para adicionar mensagens até que o limite máximo de tamanho do lote em bytes seja atingido . Nesse ponto, um MessageSizeExceededError será gerado.
Use o método create_message_batch de ServiceBusSender para criar um objeto ServiceBusMessageBatch em vez de instanciar um objeto ServiceBusMessageBatch diretamente.
- Herança
-
builtins.objectServiceBusMessageBatch
Construtor
ServiceBusMessageBatch(max_size_in_bytes: int | None = None, **kwargs: Any)
Parâmetros
Nome | Description |
---|---|
max_size_in_bytes
|
O tamanho máximo dos dados de bytes que um objeto ServiceBusMessageBatch pode conter. Valor padrão: None
|
Métodos
add_message |
Tente adicionar uma única Mensagem ao lote. O tamanho total de uma mensagem adicionada é a soma de seu corpo, propriedades etc. Se esse tamanho adicionado resultar no lote excedendo o tamanho máximo do lote, um MessageSizeExceededError será gerado. |
add_message
Tente adicionar uma única Mensagem ao lote.
O tamanho total de uma mensagem adicionada é a soma de seu corpo, propriedades etc. Se esse tamanho adicionado resultar no lote excedendo o tamanho máximo do lote, um MessageSizeExceededError será gerado.
add_message(message: ServiceBusMessage | AmqpAnnotatedMessage | Mapping[str, Any]) -> None
Parâmetros
Nome | Description |
---|---|
message
Obrigatório
|
A Mensagem a ser adicionada ao lote. |
Exceções
Tipo | Description |
---|---|
<xref:azure.servicebus.exceptions.MessageSizeExceededError>, <xref:when exceeding the size limit.>
|
Atributos
max_size_in_bytes
O tamanho máximo dos dados de bytes que um objeto ServiceBusMessageBatch pode conter.
Retornos
Tipo | Description |
---|---|
message
Obtenha o uamqp subjacente. BatchMessage ou LegacyBatchMessage. Isso foi preterido e será removido em uma versão posterior.
Retornos
Tipo | Description |
---|---|
<xref:uamqp.BatchMessage>,
<xref:LegacyBatchMessage>
|
size_in_bytes
Azure SDK for Python