QueueMessage Класс

  • Ссылка

Объект сообщения очереди.

Наследование
azure.functions._abc.QueueMessage
QueueMessage

Конструктор

QueueMessage(*, id: str | None = None, body: str | bytes | None = None, pop_receipt: str | None = None)

Параметры

Имя Описание
id
Обязательно
str

Необязательная строка, указывающая идентификатор сообщения.
body
Обязательно

Экземпляр строки или байтов, указывающий текст сообщения.
pop_receipt
Обязательно
str

Необязательная строка, содержащая маркер всплывающей квитанции.

Параметры Keyword-Only

Имя Описание
id
Обязательно
body
Обязательно
pop_receipt
Обязательно

Методы

get_body

Возвращает содержимое сообщения в виде байтов.
get_json

Декодирование и возврат содержимого сообщения в виде объекта JSON.

get_body

Возвращает содержимое сообщения в виде байтов.

get_body() -> bytes

get_json

Декодирование и возврат содержимого сообщения в виде объекта JSON.

get_json() -> Any

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

Тип Описание

Декодированные данные JSON.

Исключения

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

если текст сообщения не содержит допустимые данные JSON.

Атрибуты

dequeue_count

Количество раз, когда сообщение было выведено из очереди.

expiration_time

Объект datetime со временем истечения срока действия сообщения.

id

Идентификатор сообщения.

insertion_time

Объект datetime со временем вставки очереди сообщений.

pop_receipt

Сообщение выводит маркер квитанции в виде строки.

time_next_visible

Объект datetime с временем следующего отображения сообщения.