Sdílet prostřednictvím

EventData Třída

  • Reference

Třída EventData je kontejner pro obsah události.

Dědičnost
builtins.object
EventData

Konstruktor

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

Parametry

Name Description
body
str nebo bytes

Data, která se mají odeslat v jedné zprávě. body mohou být typu str nebo bytes.

výchozí hodnota: None

Příklady

Vytváření instancí EventData


       from azure.eventhub import EventData

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

Metody

body_as_json

Obsah události načtený jako objekt JSON, pokud jsou data kompatibilní.
body_as_str

Obsah události jako řetězec, pokud jsou data kompatibilního typu.
from_message_content

Vytvoří objekt EventData daného typu obsahu a hodnotu obsahu, která má být nastavena jako tělo.

body_as_json

Obsah události načtený jako objekt JSON, pokud jsou data kompatibilní.

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

Parametry

Name Description
encoding
str

Kódování, které se má použít pro dekódování dat událostí. Výchozí hodnota je UTF-8.

výchozí hodnota: UTF-8

Návraty

Typ Description
dict[str, any]

Objekt JSON.

body_as_str

Obsah události jako řetězec, pokud jsou data kompatibilního typu.

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

Parametry

Name Description
encoding
str

Kódování, které se má použít pro dekódování dat událostí. Výchozí hodnota je UTF-8.

výchozí hodnota: UTF-8

Návraty

Typ Description
str

Obsah události jako řetězec.

from_message_content

Vytvoří objekt EventData daného typu obsahu a hodnotu obsahu, která má být nastavena jako tělo.

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

Parametry

Name Description
content
Vyžadováno
bytes

Hodnota obsahu, která se má nastavit jako text zprávy.
content_type
Vyžadováno
str

Typ obsahu, který má být nastaven ve zprávě.

Návraty

Typ Description
EventData

Objekt EventData.

Atributy

body

Text zprávy. Formát se může lišit v závislosti na typu textu: Pro DATAmůže být tělo bajty nebo iterable[bajty]. Text SEQUENCEmůže být List nebo Iterable[List]. V VALUEpřípadě může být tělo libovolného typu.

Návraty

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

body_type

Typ textu podkladové zprávy AMQP.

Návraty

Typ Description
AmqpMessageBodyType

content_type

Popisovač typu obsahu. Volitelně popisuje datovou část zprávy, přičemž popisovač následuje za formátem RFC2045, Oddíl 5, například application/json. :rtype: str nebo None

correlation_id

Identifikátor korelace. Umožňuje aplikaci zadat kontext zprávy pro účely korelace, například odrážet MessageId zprávy, na kterou odpovídáte. :rtype: str nebo None

enqueued_time

Časové razítko události ve frontě.

Návraty

Typ Description
datetime,
None

message

Získejte základní uamqp. Message nebo LegacyMessage. Tato možnost je zastaralá a v pozdější verzi se odebere.

Návraty

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

message_id

ID pro identifikaci zprávy. Identifikátor zprávy je hodnota definovaná aplikací, která jednoznačně identifikuje zprávu a její datovou část. Identifikátor je řetězec volného tvaru a může odrážet identifikátor GUID nebo identifikátor odvozený z kontextu aplikace. Pokud je funkce zjišťování duplicit povolená, identifikuje a odebere druhé a další odeslání zpráv se stejným ID zprávy. :rtype: str nebo None

offset

Posun události.

Návraty

Typ Description
str,
None

partition_key

Klíč oddílu události.

Návraty

Typ Description
bytes,
None

properties

Vlastnosti události definované aplikací.

Návraty

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

raw_amqp_message

Pouze rozšířené využití. Interní datová část zprávy AMQP, která je odeslána nebo přijata.

Návraty

Typ Description
AmqpAnnotatedMessage

sequence_number

Pořadové číslo události.

Návraty

Typ Description
int,
None

system_properties

Metadata nastavená službou Event Hubs Service přidružená k události

EventData může obsahovat některá nebo všechna následující metadata v závislosti na zdroji dat události.

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

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

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

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

  • b"id zprávy" (bajty)

  • b"user-id" (bajty)

  • b"to" (bajty)

  • b"předmět" (bajty)

  • b"odpovědět" (bajty)

  • b"id korelace" (bajty)

  • b"content-type" (bajty)

  • b"kódování obsahu" (bajty)

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

  • b"čas vytvoření" (int)

  • b"group-id" (bajty)

  • b"group-sequence" (bajty)

  • b"id odpovědi skupině" (bajty)

Návraty

Typ Description
dict[bytes, any]