QueueMessage クラス

  • リファレンス

Queue メッセージ オブジェクト。

継承
azure.functions._abc.QueueMessage
QueueMessage

コンストラクター

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

パラメーター

名前 説明
id
必須
str

メッセージの ID を指定する省略可能な文字列。
body
必須

メッセージ本文を指定する文字列またはバイト インスタンス。
pop_receipt
必須
str

ポップレシート トークンを含む省略可能な文字列。

キーワードのみのパラメーター

名前 説明
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

メッセージ ID。

insertion_time

メッセージ キューの挿入時刻を含む datetime オブジェクト。

pop_receipt

メッセージポップレシートトークンを文字列として返します。

time_next_visible

メッセージが次に表示される時刻を含む datetime オブジェクト。