EventData Klas

De klasse EventData is een container voor gebeurtenisinhoud.

Overname

builtins.object

EventData

Constructor

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

Parameters

Name	Description
body	str of bytes De gegevens die in één bericht moeten worden verzonden. hoofdtekst kan het type str of bytes zijn. standaardwaarde: None

Voorbeelden

Exemplaren van EventData maken

       from azure.eventhub import EventData

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

Methoden

body_as_json	De inhoud van de gebeurtenis die is geladen als een JSON-object, als de gegevens compatibel zijn.
body_as_str	De inhoud van de gebeurtenis als een tekenreeks, als de gegevens van een compatibel type zijn.
from_message_content	Hiermee maakt u een EventData-object met een bepaald inhoudstype en een inhoudswaarde die moet worden ingesteld als hoofdtekst.

body_as_json

De inhoud van de gebeurtenis die is geladen als een JSON-object, als de gegevens compatibel zijn.

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

Parameters

Name	Description
encoding	str De codering die moet worden gebruikt voor het decoderen van gebeurtenisgegevens. De standaardwaarde is UTF-8 standaardwaarde: UTF-8

Retouren

Type	Description
dict[str, any]	Een JSON-object.

body_as_str

De inhoud van de gebeurtenis als een tekenreeks, als de gegevens van een compatibel type zijn.

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

Parameters

Name	Description
encoding	str De codering die moet worden gebruikt voor het decoderen van gebeurtenisgegevens. De standaardwaarde is UTF-8 standaardwaarde: UTF-8

Retouren

Type	Description
str	De inhoud van de gebeurtenis als een tekenreeks.

from_message_content

Hiermee maakt u een EventData-object met een bepaald inhoudstype en een inhoudswaarde die moet worden ingesteld als hoofdtekst.

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

Parameters

Name	Description
content Vereist	bytes De inhoudswaarde die moet worden ingesteld als de hoofdtekst van het bericht.
content_type Vereist	str Het inhoudstype dat moet worden ingesteld voor het bericht.

Retouren

Type	Description
EventData	Een EventData-object.

Kenmerken

body

De hoofdtekst van het bericht. De indeling kan variëren, afhankelijk van het type hoofdtekst: Voor DATAkan de hoofdtekst bytes of Iterable[bytes] zijn. Voor SEQUENCEkan de hoofdtekst List of Iterable[List] zijn. Voor VALUEkan de hoofdtekst elk type zijn.

Retouren

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

body_type

Het type hoofdtekst van het onderliggende AMQP-bericht.

Retouren

Type	Description
AmqpMessageBodyType

content_type

De beschrijving van het inhoudstype. Beschrijft eventueel de nettolading van het bericht, met een descriptor volgens de indeling van RFC2045, sectie 5, bijvoorbeeld 'application/json'. :rtype: str of None

correlation_id

De correlatie-id. Hiermee kan een toepassing een context voor het bericht opgeven voor correlatiedoeleinden, bijvoorbeeld de MessageId weergeven van een bericht waarop wordt gereageerd. :rtype: str of None

enqueued_time

De ge enqueued tijdstempel van de gebeurtenis.

Retouren

Type	Description
datetime, None

message

Haal de onderliggende uamqp op. Bericht of LegacyMessage. Dit wordt afgeschaft en wordt in een latere versie verwijderd.

Retouren

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

message_id

De id om het bericht te identificeren. De bericht-id is een door de toepassing gedefinieerde waarde die het bericht en de nettolading uniek identificeert. De id is een vrije tekenreeks en kan een GUID of een id weergeven die is afgeleid van de toepassingscontext. Als deze functie is ingeschakeld, worden tweede en verdere verzendingen van berichten met dezelfde bericht-id geïdentificeerd en verwijderd. :rtype: str of None

offset

De offset van de gebeurtenis.

Retouren

Type	Description
str, None

partition_key

De partitiesleutel van de gebeurtenis.

Retouren

Type	Description
bytes, None

properties

Toepassingsgedefinieerde eigenschappen voor de gebeurtenis.

Retouren

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

raw_amqp_message

Alleen geavanceerd gebruik. De nettolading van het interne AMQP-bericht die wordt verzonden of ontvangen.

Retouren

Type	Description
AmqpAnnotatedMessage

sequence_number

Het volgnummer van de gebeurtenis.

Retouren

Type	Description
int, None

system_properties

Metagegevens die zijn ingesteld door de Event Hubs-service die is gekoppeld aan de gebeurtenis.

Een EventData kan sommige of alle van de volgende metagegevens bevatten, afhankelijk van de bron van de gebeurtenisgegevens.

• 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-verlooptijd" (int)

• b"creation-time" (int)

• b"group-id" (bytes)

• b"group-sequence" (bytes)

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

Retouren

Type	Description
dict[bytes, any]