EventData Класс

Класс EventData — это контейнер для содержимого события.

Наследование

builtins.object

EventData

Конструктор

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

Параметры

Имя	Описание
body	str или bytes Данные, отправляемые в одном сообщении. Body может иметь тип str или байт. значение по умолчанию: None

Примеры

Создание экземпляров EventData

       from azure.eventhub import EventData

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

Методы

body_as_json	Содержимое события, загруженного в виде объекта JSON, если данные совместимы.
body_as_str	Содержимое события в виде строки, если данные являются совместимыми типами.
from_message_content	Создает объект EventData с заданным типом контента и значением содержимого, которое должно быть задано в качестве основного текста.

body_as_json

Содержимое события, загруженного в виде объекта JSON, если данные совместимы.

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

Параметры

Имя	Описание
encoding	str Кодировка, используемая для декодирования данных событий. Значение по умолчанию — UTF-8. значение по умолчанию: UTF-8

Возвращаемое значение

Тип	Описание
dict[str, any]	Объект JSON.

body_as_str

Содержимое события в виде строки, если данные являются совместимыми типами.

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

Параметры

Имя	Описание
encoding	str Кодировка, используемая для декодирования данных событий. Значение по умолчанию — UTF-8. значение по умолчанию: UTF-8

Возвращаемое значение

Тип	Описание
str	Содержимое события в виде строки.

from_message_content

Создает объект EventData с заданным типом контента и значением содержимого, которое должно быть задано в качестве основного текста.

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

Параметры

Имя	Описание
content Обязательно	bytes Значение содержимого, которое должно быть задано в качестве основного текста сообщения.
content_type Обязательно	str Тип контента, который необходимо задать в сообщении.

Возвращаемое значение

Тип	Описание
EventData	Объект EventData.

Атрибуты

body

Текст сообщения. Формат может отличаться в зависимости от типа текста: для DATA— текст может быть байтами или итерируемыми[байтами]. Для SEQUENCEтекст может быть List или Iterable[List]. Для VALUEтекст может иметь любой тип.

Возвращаемое значение

Тип	Описание
int, bool, float, bytes, str, dict, list, UUID

body_type

Тип текста базового сообщения AMQP.

Возвращаемое значение

Тип	Описание
AmqpMessageBodyType

content_type

Дескриптор типа контента. При необходимости описывает полезные данные сообщения с дескрипторов в формате RFC2045, раздел 5, например "application/json". :rtype: str или None

correlation_id

Идентификатор корреляции. Позволяет приложению указать контекст сообщения для корреляции, например MessageId сообщения, для которого предоставляется ответ. :rtype: str или None

enqueued_time

Метка времени события, помещенная в очередь.

Возвращаемое значение

Тип	Описание
datetime, None

message

Получите базовый uamqp. Message или LegacyMessage. Эта версия является устаревшей и будет удалена в более позднем выпуске.

Возвращаемое значение

Тип	Описание
<xref:uamqp.Message>, <xref:LegacyMessage>

message_id

Идентификатор для идентификации сообщения. Идентификатор сообщения — это определяемое приложением значение, позволяющее уникально идентифицировать сообщение и его полезные данные. Идентификатор — это строка в свободной форме, которая может отразить глобальный уникальный идентификатор или идентификатор, производный от контекста приложения. Если этот параметр включен, функция обнаружения дубликатов идентифицирует и удаляет вторую и последующие отправки сообщений с тем же идентификатором. :rtype: str или None

offset

Смещение события.

Возвращаемое значение

Тип	Описание
str, None

partition_key

Ключ секции события.

Возвращаемое значение

Тип	Описание
bytes, None

properties

Определяемые приложением свойства события.

Возвращаемое значение

Тип	Описание
dict[str, any], dict[bytes, any]

raw_amqp_message

Только расширенное использование. Отправленные или полученные внутренние полезные данные сообщения AMQP.

Возвращаемое значение

Тип	Описание
AmqpAnnotatedMessage

sequence_number

Порядковый номер события.

Возвращаемое значение

Тип	Описание
int, None

system_properties

Метаданные, заданные службой Центров событий, связанной с событием.

EventData может содержать некоторые или все следующие метаданные в зависимости от источника данных события.

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

• b"x-opt-offset" (байт)

• b"x-opt-partition-key" (байт)

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

• b"message-id" (байты)

• b"user-id" (байты)

• b"to" (байты)

• b"subject" (байт)

• b"reply-to" (байты)

• b"correlation-id" (байты)

• b"content-type" (байты)

• b"content-encoding" (байты)

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

• b"время создания" (int)

• b"group-id" (байты)

• b"group-sequence" (байты)

• b"reply-to-group-id" (байты)

Возвращаемое значение

Тип	Описание
dict[bytes, any]