EventDataBatch Klasse

Ein Batch von Ereignissen.

Das Senden von Ereignissen in einem Batch ist performanter als das Senden einzelner Ereignisse. EventDataBatch hilft Ihnen beim Erstellen der maximal zulässigen EventData-Größe , um die Sendeleistung zu verbessern.

Verwenden Sie die add-Methode , um Ereignisse hinzuzufügen, bis die maximale Batchgröße in Byte erreicht ist. An diesem Punkt wird ein ValueError ausgelöst. Verwenden Sie die send_batch-Methode von EventHubProducerClient oder die async-Methode EventHubProducerClient zum Senden.

Verwenden Sie die create_batch-Methode von EventHubProducerClient, um ein EventDataBatch-Objekt zu erstellen, anstatt ein EventDataBatch-Objekt direkt zu instanziieren.

WARNUNG: Das Aktualisieren des Werts der Instanzvariablen max_size_in_bytes für ein instanziiertes EventDataBatch-Objekt ist ÄUßERST ENTMUTIGT. Der aktualisierte max_size_in_bytes-Wert kann mit der maximalen Größe von Ereignissen in Konflikt treten, die vom Event Hubs-Dienst zulässig sind, und zu einem Sendefehler führen.

Vererbung

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)

Parameter

Name	Beschreibung
max_size_in_bytes	int Die maximale Größe der Bytedaten, die ein EventDataBatch-Objekt enthalten kann. Standardwert: None
partition_id	str Die spezifische Partitions-ID, an die gesendet werden soll. Standardwert: None
partition_key	str Mit dem angegebenen partition_key werden Ereignisdaten an eine bestimmte Partition des Event Hubs gesendet, die vom Dienst festgelegt wird. Standardwert: None

Methoden

add	Versuchen Sie, dem Batch ein EventData-Objekt hinzuzufügen. Die Gesamtgröße eines hinzugefügten Ereignisses ist die Summe seines Texts, seiner Eigenschaften usw. Wenn diese hinzugefügte Größe dazu führt, dass der Batch die maximale Batchgröße überschreitet, wird ein ValueError ausgelöst.

add

Versuchen Sie, dem Batch ein EventData-Objekt hinzuzufügen.

Die Gesamtgröße eines hinzugefügten Ereignisses ist die Summe seines Texts, seiner Eigenschaften usw. Wenn diese hinzugefügte Größe dazu führt, dass der Batch die maximale Batchgröße überschreitet, wird ein ValueError ausgelöst.

add(event_data: EventData | AmqpAnnotatedMessage) -> None

Parameter

Name	Beschreibung
event_data Erforderlich	Union[EventData, AmqpAnnotatedMessage] Das EventData,das dem Batch hinzugefügt werden soll.

Gibt zurück

Typ	Beschreibung
None

Attribute

message

Rufen Sie den zugrunde liegenden uamqp ab. BatchMessage oder LegacyBatchMessage. Dies ist veraltet und wird in einer späteren Version entfernt.

Gibt zurück

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

size_in_bytes

Die kombinierte Größe der Ereignisse im Batch in Bytes.

Gibt zurück

Typ	Beschreibung
int