Share via

EventData Classe

  • Référence

La classe EventData est un conteneur pour le contenu de l’événement.

Héritage
builtins.object
EventData

Constructeur

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

Paramètres

Nom Description
body
str ou bytes

Données à envoyer dans un seul message. body peut être de type str ou octets.

valeur par défaut: None

Exemples

Créer des instances d’EventData


       from azure.eventhub import EventData

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

Méthodes

body_as_json

Contenu de l’événement chargé en tant qu’objet JSON, si les données sont compatibles.
body_as_str

Contenu de l’événement sous forme de chaîne, si les données sont d’un type compatible.
from_message_content

Crée un objet EventData en fonction du type de contenu et d’une valeur de contenu à définir comme corps.

body_as_json

Contenu de l’événement chargé en tant qu’objet JSON, si les données sont compatibles.

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

Paramètres

Nom Description
encoding
str

Encodage à utiliser pour décoder les données d’événement. La valeur par défaut est « UTF-8 »

valeur par défaut: UTF-8

Retours

Type Description
dict[str, any]

Un objet JSON.

body_as_str

Contenu de l’événement sous forme de chaîne, si les données sont d’un type compatible.

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

Paramètres

Nom Description
encoding
str

Encodage à utiliser pour décoder les données d’événement. La valeur par défaut est « UTF-8 »

valeur par défaut: UTF-8

Retours

Type Description
str

Contenu de l’événement sous forme de chaîne.

from_message_content

Crée un objet EventData en fonction du type de contenu et d’une valeur de contenu à définir comme corps.

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

Paramètres

Nom Description
content
Obligatoire
bytes

Valeur de contenu à définir comme corps du message.
content_type
Obligatoire
str

Type de contenu à définir sur le message.

Retours

Type Description
EventData

Objet EventData.

Attributs

body

Corps du message. Le format peut varier en fonction du type de corps : Pour DATA, le corps peut être octets ou itérable[octets]. Pour SEQUENCE, le corps peut être List ou Iterable[List]. Pour VALUE, le corps peut être n’importe quel type.

Retours

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

body_type

Type de corps du message AMQP sous-jacent.

Retours

Type Description
AmqpMessageBodyType

content_type

Descripteur de type de contenu. Décrit éventuellement la charge utile du message, avec un descripteur au format RFC2045, Section 5, par exemple « application/json ». :rtype : str ou None

correlation_id

Identificateur de corrélation. Cette propriété permet à une application de spécifier un contexte pour le message à des fins de corrélation, qui reflète par exemple l’élément MessageId d’un message recevant une réponse. :rtype : str ou None

enqueued_time

Horodatage mis en file d’attente de l’événement.

Retours

Type Description
datetime,
None

message

Obtenez l’uamqp sous-jacent. Message ou LegacyMessage. Cette option est déconseillée et sera supprimée dans une version ultérieure.

Retours

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

message_id

ID permettant d’identifier le message. L’identificateur de message est une valeur définie par l’application qui identifie de manière unique le message et sa charge utile. Cet identificateur est une chaîne à structure libre et peut refléter un identificateur global unique (GUID) ou un identificateur dérivé du contexte de l’application. Si elle est activée, la fonctionnalité de détection des doublons identifie et supprime les envois secondaires et ultérieurs de messages avec le même ID de message. :rtype : str ou None

offset

Décalage de l’événement.

Retours

Type Description
str,
None

partition_key

Clé de partition de l’événement.

Retours

Type Description
bytes,
None

properties

Propriétés définies par l’application sur l’événement.

Retours

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

raw_amqp_message

Utilisation avancée uniquement. Charge utile de message AMQP interne envoyée ou reçue.

Retours

Type Description
AmqpAnnotatedMessage

sequence_number

Numéro de séquence de l’événement.

Retours

Type Description
int,
None

system_properties

Métadonnées définies par le service Event Hubs associé à l’événement.

Un EventData peut avoir tout ou partie des métadonnées suivantes en fonction de la source des données d’événement.

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

  • b"x-opt-offset » (octets)

  • b"x-opt-partition-key » (octets)

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

  • b"message-id » (octets)

  • b"user-id » (octets)

  • b"to » (octets)

  • b"subject » (octets)

  • b"reply-to » (octets)

  • b"correlation-id » (octets)

  • b"content-type » (octets)

  • b"content-encoding » (octets)

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

  • b"creation-time » (int)

  • b"group-id » (octets)

  • b"group-sequence » (octets)

  • b"reply-to-group-id » (octets)

Retours

Type Description
dict[bytes, any]