EventData Klass

  • Referens

Klassen EventData är en container för händelseinnehåll.

Arv
builtins.object
EventData

Konstruktor

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

Parametrar

Name Description
body
str eller bytes

De data som ska skickas i ett enda meddelande. kan vara typ av str eller byte.

standardvärde: None

Exempel

Skapa instanser av EventData


       from azure.eventhub import EventData

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

Metoder

body_as_json

Innehållet i händelsen som läses in som ett JSON-objekt, om data är kompatibla.
body_as_str

Innehållet i händelsen som en sträng, om data är av en kompatibel typ.
from_message_content

Skapar ett EventData-objekt med en viss innehållstyp och ett innehållsvärde som ska anges som brödtext.

body_as_json

Innehållet i händelsen som läses in som ett JSON-objekt, om data är kompatibla.

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

Parametrar

Name Description
encoding
str

Den kodning som ska användas för avkodning av händelsedata. Standardvärdet är "UTF-8"

standardvärde: UTF-8

Returer

Typ Description
dict[str, any]

Ett JSON-objekt.

body_as_str

Innehållet i händelsen som en sträng, om data är av en kompatibel typ.

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

Parametrar

Name Description
encoding
str

Den kodning som ska användas för avkodning av händelsedata. Standardvärdet är "UTF-8"

standardvärde: UTF-8

Returer

Typ Description
str

Innehållet i händelsen som en sträng.

from_message_content

Skapar ett EventData-objekt med en viss innehållstyp och ett innehållsvärde som ska anges som brödtext.

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

Parametrar

Name Description
content
Obligatorisk
bytes

Innehållsvärdet som ska anges som brödtext i meddelandet.
content_type
Obligatorisk
str

Innehållstypen som ska anges i meddelandet.

Returer

Typ Description
EventData

Ett EventData-objekt.

Attribut

body

Brödtexten i meddelandet. Formatet kan variera beroende på brödtexttyp: För DATAkan brödtexten vara byte eller Iterable[bytes]. För SEQUENCEkan brödtexten vara List eller Iterable[List]. För VALUEkan brödtexten vara vilken typ som helst.

Returer

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

body_type

Brödtexttypen för det underliggande AMQP-meddelandet.

Returer

Typ Description
AmqpMessageBodyType

content_type

Innehållstypbeskrivning. Du kan också beskriva nyttolasten för meddelandet, med en beskrivning som följer formatet för RFC2045, avsnitt 5, till exempel "application/json". :rtype: str eller None

correlation_id

Korrelationsidentifieraren. Gör att ett program kan ange en kontext för meddelandet för korrelation, till exempel för att återspegla MessageId för ett meddelande som besvaras. :rtype: str eller None

enqueued_time

Den köade tidsstämpeln för händelsen.

Returer

Typ Description
datetime,
None

message

Hämta den underliggande uamqp. Message eller LegacyMessage. Detta är inaktuellt och tas bort i en senare version.

Returer

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

message_id

ID:t för att identifiera meddelandet. Meddelandeidentifieraren är ett programdefinierat värde som unikt identifierar meddelandet och dess nyttolast. Identifieraren är en sträng i fritt format och kan återspegla ett GUID eller en identifierare som härleds från programkontexten. Om den är aktiverad identifierar och tar dubblettidentifieringsfunktionen bort andra och ytterligare inlämningar av meddelanden med samma meddelande-ID. :rtype: str eller None

offset

Förskjutningen av händelsen.

Returer

Typ Description
str,
None

partition_key

Partitionsnyckeln för händelsen.

Returer

Typ Description
bytes,
None

properties

Programdefinierade egenskaper för händelsen.

Returer

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

raw_amqp_message

Endast avancerad användning. Den interna AMQP-meddelandenyttolasten som skickas eller tas emot.

Returer

Typ Description
AmqpAnnotatedMessage

sequence_number

Händelsens sekvensnummer.

Returer

Typ Description
int,
None

system_properties

Metadata som anges av event hubs-tjänsten som är associerad med händelsen.

En EventData kan ha vissa eller alla följande metadata beroende på källan till händelsedata.

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

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

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

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

  • b"message-id" (byte)

  • b"user-id" (byte)

  • b"till" (byte)

  • b"ämne" (byte)

  • b"reply-to" (byte)

  • b"correlation-id" (byte)

  • b"content-type" (byte)

  • b"content-encoding" (byte)

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

  • b"creation-time" (int)

  • b"grupp-ID" (byte)

  • b"group-sequence" (byte)

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

Returer

Typ Description
dict[bytes, any]