EventDataBatch Classe
Um lote de eventos.
O envio de eventos em um lote é mais eficaz do que o envio de eventos individuais. EventDataBatch ajuda você a criar o lote de tamanho máximo permitido de EventData para melhorar o desempenho de envio.
Use o método add para adicionar eventos até que o limite máximo de tamanho do lote em bytes seja atingido . Nesse ponto, um ValueError será gerado. Use o método send_batch de EventHubProducerClient ou assíncrono EventHubProducerClient para envio.
Use o método create_batch de EventHubProducerClient para criar um objeto EventDataBatch em vez de instanciar um objeto EventDataBatch diretamente.
AVISO: atualizar o valor da variável de instância max_size_in_bytes em um objeto EventDataBatch instanciado é ALTAMENTE DESENCORAJADO. O valor de max_size_in_bytes atualizado pode entrar em conflito com o tamanho máximo de eventos permitidos pelo serviço de Hubs de Eventos e resultar em uma falha de envio.
- Herança
-
builtins.objectEventDataBatch
Construtor
EventDataBatch(max_size_in_bytes: int | None = None, partition_id: str | None = None, partition_key: str | bytes | None = None, **kwargs: Any)
Parâmetros
Nome | Description |
---|---|
max_size_in_bytes
|
O tamanho máximo dos dados de bytes que um objeto EventDataBatch pode conter. valor padrão: None
|
partition_id
|
A ID de partição específica para a qual enviar. valor padrão: None
|
partition_key
|
Com o partition_key fornecido, os dados de evento serão enviados para uma partição específica do Hub de Eventos decidida pelo serviço. valor padrão: None
|
Métodos
add |
Tente adicionar um EventData ao lote. O tamanho total de um evento adicionado é a soma de seu corpo, propriedades etc. Se esse tamanho adicionado resultar no lote excedendo o tamanho máximo do lote, um ValueError será gerado. |
add
Tente adicionar um EventData ao lote.
O tamanho total de um evento adicionado é a soma de seu corpo, propriedades etc. Se esse tamanho adicionado resultar no lote excedendo o tamanho máximo do lote, um ValueError será gerado.
add(event_data: EventData | AmqpAnnotatedMessage) -> None
Parâmetros
Nome | Description |
---|---|
event_data
Obrigatório
|
O EventData a ser adicionado ao lote. |
Retornos
Tipo | Description |
---|---|
Atributos
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