Share via

EventData Klasse

  • Referenz

Die EventData-Klasse ist ein Container für Ereignisinhalte.

Vererbung
builtins.object
EventData

Konstruktor

EventData(body: str | bytes | List | None = None)

Parameter

Name Beschreibung
body
str oder bytes

Die Daten, die in einer einzelnen Nachricht gesendet werden sollen. body kann der Typ "str" oder "Bytes" sein.

Standardwert: None

Beispiele

Erstellen von Instanzen von EventData


       from azure.eventhub import EventData

       event_data = EventData("String data")
       event_data = EventData(b"Bytes data")

Methoden

body_as_json

Der Inhalt des Ereignisses, das als JSON-Objekt geladen wird, wenn die Daten kompatibel sind.
body_as_str

Der Inhalt des Ereignisses als Zeichenfolge, wenn die Daten einen kompatiblen Typ aufweisen.
from_message_content

Erstellt ein EventData-Objekt, das dem Inhaltstyp und einem Inhaltswert zugewiesen wird, der als Text festgelegt werden soll.

body_as_json

Der Inhalt des Ereignisses, das als JSON-Objekt geladen wird, wenn die Daten kompatibel sind.

body_as_json(encoding: str = 'UTF-8') -> Dict[str, Any]

Parameter

Name Beschreibung
encoding
str

Die Codierung, die zum Decodieren von Ereignisdaten verwendet werden soll. Standardwert ist "UTF-8"

Standardwert: UTF-8

Gibt zurück

Typ Beschreibung
dict[str, any]

Ein JSON-Objekt.

body_as_str

Der Inhalt des Ereignisses als Zeichenfolge, wenn die Daten einen kompatiblen Typ aufweisen.

body_as_str(encoding: str = 'UTF-8') -> str

Parameter

Name Beschreibung
encoding
str

Die Codierung, die zum Decodieren von Ereignisdaten verwendet werden soll. Standardwert ist "UTF-8"

Standardwert: UTF-8

Gibt zurück

Typ Beschreibung
str

Der Inhalt des Ereignisses als Zeichenfolge.

from_message_content

Erstellt ein EventData-Objekt, das dem Inhaltstyp und einem Inhaltswert zugewiesen wird, der als Text festgelegt werden soll.

from_message_content(content: bytes, content_type: str, **kwargs: Any) -> EventData

Parameter

Name Beschreibung
content
Erforderlich
bytes

Der Inhaltswert, der als Textkörper der Nachricht festgelegt werden soll.
content_type
Erforderlich
str

Der Inhaltstyp, der für die Nachricht festgelegt werden soll.

Gibt zurück

Typ Beschreibung
EventData

Ein EventData-Objekt.

Attribute

body

Der Textkörper der Nachricht. Das Format kann je nach Textkörpertyp variieren: Für DATAkann der Text Bytes oder Iterable[Bytes] sein. Für SEQUENCEkönnte der Text list oder Iterable[List] sein. Für VALUEkann der Textkörper ein beliebiger Typ sein.

Gibt zurück

Typ Beschreibung
int,
bool,
float,
bytes,
str,
dict,
list,
UUID

body_type

Der Texttyp der zugrunde liegenden AMQP-Nachricht.

Gibt zurück

Typ Beschreibung
AmqpMessageBodyType

content_type

Die Inhaltstypdeskriptor. Beschreibt optional die Nutzlast der Nachricht, wobei ein Deskriptor dem Format von RFC2045, Abschnitt 5 folgt, z. B. "application/json". :rtype: str oder None

correlation_id

Der Korrelationsbezeichner. Ermöglicht einer Anwendung, einen Kontext für die Nachricht zum Zweck der Korrelation anzugeben, z.B. die MessageId einer Nachricht, auf die geantwortet wird. :rtype: str oder None

enqueued_time

Der queuierte Zeitstempel des Ereignisses.

Gibt zurück

Typ Beschreibung
datetime,
None

message

Rufen Sie die zugrunde liegende uamqp ab. Nachricht oder LegacyMessage. Dies ist veraltet und wird in einer späteren Version entfernt.

Gibt zurück

Typ Beschreibung
<xref:uamqp.Message>,
<xref:LegacyMessage>

message_id

Die ID zum Identifizieren der Nachricht. Der Nachrichtenbezeichner ist ein von der Anwendung definierter Wert, der die Nachricht und ihre Nutzlast eindeutig identifiziert. Der Bezeichner ist eine Zeichenfolge in freier Form und kann eine GUID oder einen aus dem Anwendungskontext abgeleiteten Bezeichner widerspiegeln. Wenn sie aktiviert ist, identifiziert und entfernt das Feature zur Doppelten Erkennung die zweite und weitere Übermittlung von Nachrichten mit derselben Nachrichten-ID. :rtype: str oder None

offset

Der Offset des Ereignisses.

Gibt zurück

Typ Beschreibung
str,
None

partition_key

Der Partitionsschlüssel des Ereignisses.

Gibt zurück

Typ Beschreibung
bytes,
None

properties

Anwendungsdefinierte Eigenschaften für das Ereignis.

Gibt zurück

Typ Beschreibung
dict[str, any],
dict[bytes, any]

raw_amqp_message

Nur erweiterte Nutzung. Die gesendete oder empfangene interne AMQP-Nachrichtennutzlast.

Gibt zurück

Typ Beschreibung
AmqpAnnotatedMessage

sequence_number

Die Sequenznummer des Ereignisses.

Gibt zurück

Typ Beschreibung
int,
None

system_properties

Metadaten, die vom Event Hubs-Dienst festgelegt werden, der dem Ereignis zugeordnet ist.

Ein EventData-Element kann abhängig von der Quelle der Ereignisdaten über einige oder alle der folgenden Metadaten verfügen.

  • b"x-opt-sequence-number" (int)

  • b"x-opt-offset" (Bytes)

  • b"x-opt-partition-key" (Bytes)

  • b"x-opt-enqueued-time" (int)

  • b"message-id" (Bytes)

  • b"user-id" (bytes)

  • b"to" (Bytes)

  • b"subject" (Bytes)

  • b "reply-to" (Bytes)

  • b"correlation-id" (Bytes)

  • b"content-type" (Bytes)

  • b"content-encoding" (Bytes)

  • b"absolute-ablaufzeit" (int)

  • b"creation-time" (int)

  • b"group-id" (Bytes)

  • b"group-sequence" (Bytes)

  • b"reply-to-group-id" (Bytes)

Gibt zurück

Typ Beschreibung
dict[bytes, any]