Condividi tramite


EventDataBatch Classe

Batch di eventi.

L'invio di eventi in un batch è più efficiente rispetto all'invio di singoli eventi. EventDataBatch consente di creare il batch di dimensioni massime consentite di EventData per migliorare le prestazioni di invio.

Usare il metodo add per aggiungere eventi fino a quando non viene raggiunto il limite massimo di dimensioni batch in byte. A questo punto verrà generato un valore ValueError . Usare il metodo send_batch di EventHubProducerClient o l'asincrono EventHubProducerClient per l'invio.

Usare il metodo create_batch di EventHubProducerClient per creare un oggetto EventDataBatch anziché creare direttamente un'istanza di un oggetto EventDataBatch.

AVVISO: l'aggiornamento del valore della variabile di istanza max_size_in_bytes in un oggetto EventDataBatch di cui è stata creata un'istanza è ALTAMENTE SCONSIGLIATO. Il valore max_size_in_bytes aggiornato può entrare in conflitto con le dimensioni massime degli eventi consentiti dal servizio Hub eventi e generare un errore di invio.

Ereditarietà
builtins.object
EventDataBatch

Costruttore

EventDataBatch(max_size_in_bytes: int | None = None, partition_id: str | None = None, partition_key: str | bytes | None = None, **kwargs: Any)

Parametri

Nome Descrizione
max_size_in_bytes
int

Dimensioni massime dei dati byte che un oggetto EventDataBatch può contenere.

valore predefinito: None
partition_id
str

ID di partizione specifico a cui inviare.

valore predefinito: None
partition_key
str

Con il partition_key specificato, i dati dell'evento verranno inviati a una determinata partizione dell'hub eventi deciso dal servizio.

valore predefinito: None

Metodi

add

Provare ad aggiungere eventData al batch.

La dimensione totale di un evento aggiunto è la somma del corpo, delle proprietà e così via. Se questa dimensione aggiunta comporta un superamento delle dimensioni massime del batch, verrà generato un valore ValueError .

add

Provare ad aggiungere eventData al batch.

La dimensione totale di un evento aggiunto è la somma del corpo, delle proprietà e così via. Se questa dimensione aggiunta comporta un superamento delle dimensioni massime del batch, verrà generato un valore ValueError .

add(event_data: EventData | AmqpAnnotatedMessage) -> None

Parametri

Nome Descrizione
event_data
Necessario

EventData da aggiungere al batch.

Restituisce

Tipo Descrizione

Attributi

message

Ottenere l'oggetto uamqp sottostante. BatchMessage o LegacyBatchMessage. Questa operazione è deprecata e verrà rimossa in una versione successiva.

Restituisce

Tipo Descrizione
<xref:uamqp.BatchMessage>,
<xref:LegacyBatchMessage>

size_in_bytes

Dimensione combinata degli eventi nel batch, in byte.

Restituisce

Tipo Descrizione
int