EventDataBatch Klass

En batch med händelser.

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

Använd metoden add för att lägga till händelser tills den maximala gränsen för batchstorlek i byte har uppnåtts – då utlöses en ValueError . Använd metoden send_batchEventHubProducerClient eller asynkron EventHubProducerClient för att skicka.

Använd metoden create_batch EventHubProducerClient för att skapa ett EventDataBatch-objekt i stället för att instansiera ett EventDataBatch-objekt direkt.

VARNING! Det rekommenderas inte att uppdatera värdet för instansvariabeln max_size_in_bytes på ett instansierat EventDataBatch-objekt. Det uppdaterade max_size_in_bytes-värdet kan vara i konflikt med den maximala storleken på händelser som tillåts av Event Hubs-tjänsten och resultera i ett sändningsfel.

Arv

builtins.object

EventDataBatch

Konstruktor

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

Parametrar

Name	Description
max_size_in_bytes	int Den maximala storleken på bytedata som ett EventDataBatch-objekt kan innehålla. standardvärde: None
partition_id	str Det specifika partitions-ID som ska skickas till. standardvärde: None
partition_key	str Med den angivna partition_key skickas händelsedata till en viss partition av händelsehubben som bestäms av tjänsten. standardvärde: None

Metoder

add	Försök att lägga till en EventData i batchen. Den totala storleken på en tillagd händelse är summan av dess brödtext, egenskaper osv. Om den här tillagda storleken resulterar i att batchen överskrider den maximala batchstorleken utlöses en ValueError .

add

Försök att lägga till en EventData i batchen.

Den totala storleken på en tillagd händelse är summan av dess brödtext, egenskaper osv. Om den här tillagda storleken resulterar i att batchen överskrider den maximala batchstorleken utlöses en ValueError .

add(event_data: EventData | AmqpAnnotatedMessage) -> None

Parametrar

Name	Description
event_data Obligatorisk	Union[EventData, AmqpAnnotatedMessage] EventData som ska läggas till i batchen.

Returer

Typ	Description
None

Attribut

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å händelserna i batchen, i byte.

Returer

Typ	Description
int