EventData Klasa

Klasa EventData jest kontenerem zawartości zdarzenia.

Dziedziczenie

builtins.object

EventData

Konstruktor

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

Parametry

Nazwa	Opis
body	str lub bytes Dane do wysłania w jednym komunikacie. treść może być typem str lub bajtów. wartość domyślna: None

Przykłady

Tworzenie wystąpień usługi EventData

       from azure.eventhub import EventData

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

Metody

body_as_json	Zawartość zdarzenia załadowana jako obiekt JSON, jeśli dane są zgodne.
body_as_str	Zawartość zdarzenia jako ciąg, jeśli dane są zgodnego typu.
from_message_content	Tworzy obiekt EventData podany typ zawartości i wartość zawartości, która ma być ustawiana jako treść.

body_as_json

Zawartość zdarzenia załadowana jako obiekt JSON, jeśli dane są zgodne.

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

Parametry

Nazwa	Opis
encoding	str Kodowanie używane do dekodowania danych zdarzeń. Wartość domyślna to "UTF-8" wartość domyślna: UTF-8

Zwraca

Typ	Opis
dict[str, any]	Obiekt JSON.

body_as_str

Zawartość zdarzenia jako ciąg, jeśli dane są zgodnego typu.

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

Parametry

Nazwa	Opis
encoding	str Kodowanie używane do dekodowania danych zdarzeń. Wartość domyślna to "UTF-8" wartość domyślna: UTF-8

Zwraca

Typ	Opis
str	Zawartość zdarzenia jako ciąg.

from_message_content

Tworzy obiekt EventData podany typ zawartości i wartość zawartości, która ma być ustawiana jako treść.

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

Parametry

Nazwa	Opis
content Wymagane	bytes Wartość zawartości, która ma zostać ustawiona jako treść wiadomości.
content_type Wymagane	str Typ zawartości, który ma zostać ustawiony w komunikacie.

Zwraca

Typ	Opis
EventData	Obiekt EventData.

Atrybuty

body

Treść wiadomości. Format może się różnić w zależności od typu treści: dla DATAelementu treść może być bajty lub iterowalne[bajty]. W przypadku SEQUENCEelementu treść może mieć wartość List lub Iterable[List]. W przypadku VALUEelementu treść może być dowolnym typem.

Zwraca

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

body_type

Typ treści bazowego komunikatu AMQP.

Zwraca

Typ	Opis
AmqpMessageBodyType

content_type

Deskryptor typu zawartości. Opcjonalnie opisuje ładunek komunikatu z deskryptorem w formacie RFC2045, sekcja 5, na przykład "application/json". :rtype: str lub None

correlation_id

Identyfikator korelacji. Umożliwia aplikacji określenie kontekstu komunikatu na potrzeby korelacji, na przykład odzwierciedlając identyfikator MessageId komunikatu, do którego jest odpowiadana. :rtype: str lub None

enqueued_time

W kolejce sygnatura czasowa zdarzenia.

Zwraca

Typ	Opis
datetime, None

message

Pobierz podstawowy uamqp. Komunikat lub Starsza wersjaMessage. Jest to przestarzałe i zostanie usunięte w nowszej wersji.

Zwraca

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

message_id

Identyfikator umożliwiający zidentyfikowanie komunikatu. Identyfikator komunikatu to wartość zdefiniowana przez aplikację, która jednoznacznie identyfikuje komunikat i jego ładunek. Identyfikator jest ciągiem bez formularza i może odzwierciedlać identyfikator GUID lub identyfikator pochodzący z kontekstu aplikacji. Jeśli ta funkcja wykrywania jest włączona, funkcja wykrywania duplikatów identyfikuje i usuwa drugie i dalsze przesyłanie komunikatów o tym samym identyfikatorze komunikatu. :rtype: str lub None

offset

Przesunięcie zdarzenia.

Zwraca

Typ	Opis
str, None

partition_key

Klucz partycji zdarzenia.

Zwraca

Typ	Opis
bytes, None

properties

Właściwości zdefiniowane przez aplikację w zdarzeniu.

Zwraca

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

raw_amqp_message

Tylko zaawansowane użycie. Wewnętrzny ładunek komunikatu AMQP, który jest wysyłany lub odbierany.

Zwraca

Typ	Opis
AmqpAnnotatedMessage

sequence_number

Numer sekwencji zdarzenia.

Zwraca

Typ	Opis
int, None

system_properties

Metadane ustawione przez usługę Event Hubs skojarzone ze zdarzeniem.

Dane EventData mogą zawierać niektóre lub wszystkie następujące metadane w zależności od źródła danych zdarzenia.

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

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

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

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

• b"message-id" (bajty)

• b"user-id" (bajty)

• b"to" (bajty)

• b"subject" (bajty)

• b"reply-to" (bajty)

• b"correlation-id" (bajty)

• b"content-type" (bajty)

• b"content-encoding" (bajty)

• b"absolute-expiry-time" (int)

• b"creation-time" (int)

• b"group-id" (bajty)

• b"group-sequence" (bajty)

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

Zwraca

Typ	Opis
dict[bytes, any]