Condividi tramite

EventData Classe

  • Riferimento

La classe EventData è un contenitore per il contenuto dell'evento.

Ereditarietà
builtins.object
EventData

Costruttore

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

Parametri

Nome Descrizione
body
str oppure bytes

Dati da inviare in un singolo messaggio. body può essere di tipo str o byte.

valore predefinito: None

Esempio

Creare istanze di EventData


       from azure.eventhub import EventData

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

Metodi

body_as_json

Contenuto dell'evento caricato come oggetto JSON, se i dati sono compatibili.
body_as_str

Contenuto dell'evento come stringa, se i dati sono di un tipo compatibile.
from_message_content

Crea un oggetto EventData in base al tipo di contenuto e un valore di contenuto da impostare come corpo.

body_as_json

Contenuto dell'evento caricato come oggetto JSON, se i dati sono compatibili.

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

Parametri

Nome Descrizione
encoding
str

Codifica da usare per decodificare i dati degli eventi. Il valore predefinito è 'UTF-8'

valore predefinito: UTF-8

Restituisce

Tipo Descrizione
dict[str, any]

Oggetto JSON.

body_as_str

Contenuto dell'evento come stringa, se i dati sono di un tipo compatibile.

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

Parametri

Nome Descrizione
encoding
str

Codifica da usare per decodificare i dati degli eventi. Il valore predefinito è 'UTF-8'

valore predefinito: UTF-8

Restituisce

Tipo Descrizione
str

Contenuto dell'evento come stringa.

from_message_content

Crea un oggetto EventData in base al tipo di contenuto e un valore di contenuto da impostare come corpo.

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

Parametri

Nome Descrizione
content
Necessario
bytes

Valore del contenuto da impostare come corpo del messaggio.
content_type
Necessario
str

Tipo di contenuto da impostare nel messaggio.

Restituisce

Tipo Descrizione
EventData

Oggetto EventData.

Attributi

body

Corpo del messaggio. Il formato può variare a seconda del tipo di corpo: per DATA, il corpo potrebbe essere byte o iterabile[byte]. Per SEQUENCE, il corpo potrebbe essere List o Iterable[List]. Per VALUE, il corpo potrebbe essere qualsiasi tipo.

Restituisce

Tipo Descrizione
int,
bool,
float,
bytes,
str,
dict,
list,
UUID

body_type

Tipo di corpo del messaggio AMQP sottostante.

Restituisce

Tipo Descrizione
AmqpMessageBodyType

content_type

Descrittore del tipo di contenuto. Facoltativamente, descrive il payload del messaggio, con un descrittore che segue il formato di RFC2045, sezione 5, ad esempio "application/json". :rtype: str o Nessuno

correlation_id

Identificatore di correlazione. Consente a un'applicazione di specificare un contesto per il messaggio per finalità di correlazione, ad esempio rispecchiando il valore MessageId di un messaggio a cui si risponde. :rtype: str o Nessuno

enqueued_time

Timestamp accodato dell'evento.

Restituisce

Tipo Descrizione
datetime,
None

message

Ottenere l'oggetto uamqp sottostante. Messaggio o LegacyMessage. Questa operazione è deprecata e verrà rimossa in una versione successiva.

Restituisce

Tipo Descrizione
<xref:uamqp.Message>,
<xref:LegacyMessage>

message_id

ID per identificare il messaggio. Questo identificatore di messaggio è un valore definito dall'applicazione che identifica in modo univoco il messaggio e il rispettivo payload. L'identificatore è una stringa freeform e può rispecchiare un GUID o un identificatore derivato dal contesto dell'applicazione. Se abilitata, la funzionalità di rilevamento duplicati identifica e rimuove secondi e altri invii di messaggi con lo stesso ID messaggio. :rtype: str o Nessuno

offset

Offset dell'evento.

Restituisce

Tipo Descrizione
str,
None

partition_key

Chiave di partizione dell'evento.

Restituisce

Tipo Descrizione
bytes,
None

properties

Proprietà definite dall'applicazione sull'evento.

Restituisce

Tipo Descrizione
dict[str, any],
dict[bytes, any]

raw_amqp_message

Solo utilizzo avanzato. Payload del messaggio AMQP interno inviato o ricevuto.

Restituisce

Tipo Descrizione
AmqpAnnotatedMessage

sequence_number

Numero di sequenza dell'evento.

Restituisce

Tipo Descrizione
int,
None

system_properties

Metadati impostati dal servizio Hub eventi associato all'evento.

Un eventData può avere alcuni o tutti i metadati seguenti a seconda dell'origine dei dati dell'evento.

  • 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"to" (byte)

  • b"subject" (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"group-id" (byte)

  • b"group-sequence" (byte)

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

Restituisce

Tipo Descrizione
dict[bytes, any]