Partilhar via

EventData Classe

  • Referência

A classe EventData é um contentor para conteúdos de eventos.

Herança
builtins.object
EventData

Construtor

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

Parâmetros

Name Description
body
str ou bytes

Os dados a enviar numa única mensagem. o corpo pode ser tipo de str ou bytes.

valor predefinido: None

Exemplos

Criar instâncias de EventData


       from azure.eventhub import EventData

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

Métodos

body_as_json

O conteúdo do evento carregado como um objeto JSON, se os dados forem compatíveis.
body_as_str

O conteúdo do evento como uma cadeia, se os dados forem de um tipo compatível.
from_message_content

Cria um objeto EventData com um tipo de conteúdo e um valor de conteúdo a ser definido como corpo.

body_as_json

O conteúdo do evento carregado como um objeto JSON, se os dados forem compatíveis.

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

Parâmetros

Name Description
encoding
str

A codificação a utilizar para descodificar dados de eventos. A predefinição é "UTF-8"

valor predefinido: UTF-8

Devoluções

Tipo Description
dict[str, any]

Um objeto JSON.

body_as_str

O conteúdo do evento como uma cadeia, se os dados forem de um tipo compatível.

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

Parâmetros

Name Description
encoding
str

A codificação a utilizar para descodificar dados de eventos. A predefinição é "UTF-8"

valor predefinido: UTF-8

Devoluções

Tipo Description
str

O conteúdo do evento como uma cadeia.

from_message_content

Cria um objeto EventData com um tipo de conteúdo e um valor de conteúdo a ser definido como corpo.

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

Parâmetros

Name Description
content
Necessário
bytes

O valor de conteúdo a ser definido como o corpo da mensagem.
content_type
Necessário
str

O tipo de conteúdo a definir na mensagem.

Devoluções

Tipo Description
EventData

Um objeto EventData.

Atributos

body

O corpo da Mensagem. O formato pode variar consoante o tipo de corpo: Para DATA, o corpo pode ser bytes ou Iterável[bytes]. Para SEQUENCE, o corpo pode ser Lista ou Iterável[Lista]. Para VALUE, o corpo pode ser qualquer tipo.

Devoluções

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

body_type

O tipo de corpo da mensagem AMQP subjacente.

Devoluções

Tipo Description
AmqpMessageBodyType

content_type

O descritor do tipo de conteúdo. Opcionalmente, descreve o payload da mensagem, com um descritor a seguir ao formato de RFC2045, Secção 5, por exemplo "application/json". :rtype: str ou None

correlation_id

O identificador de correlação. Permite que uma aplicação especifique um contexto para a mensagem para fins de correlação, por exemplo, ao refletir o MessageId de uma mensagem que está a ser respondida. :rtype: str ou None

enqueued_time

O carimbo de data/hora em fila do evento.

Devoluções

Tipo Description
datetime,
None

message

Obtenha o uamqp subjacente. Mensagem ou LegacyMessage. Esta ação foi preterida e será removida numa versão posterior.

Devoluções

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

message_id

O ID para identificar a mensagem. O identificador da mensagem é um valor definido pela aplicação que identifica exclusivamente a mensagem e o respetivo payload. O identificador é uma cadeia de forma livre e pode refletir um GUID ou um identificador derivado do contexto da aplicação. Se estiver ativada, a funcionalidade de deteção duplicada identifica e remove a segunda e mais submissões de mensagens com o mesmo ID de mensagem. :rtype: str ou None

offset

O desvio do evento.

Devoluções

Tipo Description
str,
None

partition_key

A chave de partição do evento.

Devoluções

Tipo Description
bytes,
None

properties

Propriedades definidas pela aplicação no evento.

Devoluções

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

raw_amqp_message

Apenas utilização avançada. O payload de mensagens AMQP interno que é enviado ou recebido.

Devoluções

Tipo Description
AmqpAnnotatedMessage

sequence_number

O número de sequência do evento.

Devoluções

Tipo Description
int,
None

system_properties

Metadados definidos pelo Serviço de Hubs de Eventos associados ao evento.

Um EventData pode ter alguns ou todos os seguintes metadados, dependendo da origem dos dados do 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"responder a" (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)

Devoluções

Tipo Description
dict[bytes, any]