EventData Clase

  • Referencia

La clase EventData es un contenedor para el contenido del evento.

Herencia
builtins.object
EventData

Constructor

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

Parámetros

Nombre Description
body
str o bytes

Datos que se van a enviar en un único mensaje. body puede ser de tipo str o bytes.

valor predeterminado: None

Ejemplos

Creación de instancias de EventData


       from azure.eventhub import EventData

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

Métodos

body_as_json

El contenido del evento cargado como un objeto JSON, si los datos son compatibles.
body_as_str

El contenido del evento como una cadena, si los datos son de un tipo compatible.
from_message_content

Crea un objeto EventData según el tipo de contenido y un valor de contenido que se va a establecer como cuerpo.

body_as_json

El contenido del evento cargado como un objeto JSON, si los datos son compatibles.

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

Parámetros

Nombre Description
encoding
str

Codificación que se va a usar para descodificar datos de eventos. El valor predeterminado es "UTF-8"

valor predeterminado: UTF-8

Devoluciones

Tipo Description
dict[str, any]

Un objeto JSON.

body_as_str

El contenido del evento como una cadena, si los datos son de un tipo compatible.

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

Parámetros

Nombre Description
encoding
str

Codificación que se va a usar para descodificar datos de eventos. El valor predeterminado es "UTF-8"

valor predeterminado: UTF-8

Devoluciones

Tipo Description
str

Contenido del evento como una cadena.

from_message_content

Crea un objeto EventData según el tipo de contenido y un valor de contenido que se va a establecer como cuerpo.

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

Parámetros

Nombre Description
content
Requerido
bytes

Valor de contenido que se va a establecer como el cuerpo del mensaje.
content_type
Requerido
str

Tipo de contenido que se va a establecer en el mensaje.

Devoluciones

Tipo Description
EventData

Objeto EventData.

Atributos

body

Cuerpo del mensaje. El formato puede variar en función del tipo de cuerpo: para DATA, el cuerpo podría ser bytes o iterable[bytes]. Para SEQUENCE, el cuerpo podría ser List o Iterable[List]. Para VALUE, el cuerpo podría ser cualquier tipo.

Devoluciones

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

body_type

Tipo de cuerpo del mensaje AMQP subyacente.

Devoluciones

Tipo Description
AmqpMessageBodyType

content_type

Descriptor de tipo de contenido. Opcionalmente, describe la carga del mensaje, con un descriptor que sigue el formato de RFC2045, sección 5, por ejemplo, "application/json". :rtype: str o None

correlation_id

Identificador de correlación. Permite que una aplicación especifique un contexto del mensaje con fines de correlación, por ejemplo, que refleje el MessageId de un mensaje que se ha respondido. :rtype: str o None

enqueued_time

Marca de tiempo puesta en cola del evento.

Devoluciones

Tipo Description
datetime,
None

message

Obtenga el uamqp subyacente. Message o LegacyMessage. Esto está en desuso y se quitará en una versión posterior.

Devoluciones

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

message_id

Identificador para identificar el mensaje. El identificador del mensaje es un valor definido por la aplicación que identifica de forma única el mensaje y su carga. El identificador es una cadena de forma libre y puede reflejar un GUID o un identificador que se deriva del contexto de la aplicación. Si está habilitada, la característica de detección de duplicados identifica y quita los envíos de segundo y posteriores de mensajes con el mismo identificador de mensaje. :rtype: str o None

offset

Desplazamiento del evento.

Devoluciones

Tipo Description
str,
None

partition_key

Clave de partición del evento.

Devoluciones

Tipo Description
bytes,
None

properties

Propiedades definidas por la aplicación en el evento.

Devoluciones

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

raw_amqp_message

Solo uso avanzado. Carga interna del mensaje AMQP que se envía o recibe.

Devoluciones

Tipo Description
AmqpAnnotatedMessage

sequence_number

Número de secuencia del evento.

Devoluciones

Tipo Description
int,
None

system_properties

Metadatos establecidos por el servicio Event Hubs asociado al evento.

Un EventData podría tener algunos o todos los metadatos siguientes en función del origen de los datos del evento.

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

  • b"creation-time" (int)

  • b"group-id" (bytes)

  • b"group-sequence" (bytes)

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

Devoluciones

Tipo Description
dict[bytes, any]