AmqpAnnotatedMessage クラス

  • リファレンス

低レベルの AMQP メッセージ セクションにアクセスできる高度な送受信シナリオ用の AMQP 注釈付きメッセージ。 AmqpAnnotatedMessage の本文として設定するdata_body、sequence_body、またはvalue_bodyのいずれか 1 つだけが必要です。複数の本文が設定されている場合、 ValueError が発生します。 メッセージ形式の詳細については、AMQP 仕様 http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#section-message-format を参照してください。

継承
builtins.object
AmqpAnnotatedMessage

コンストラクター

AmqpAnnotatedMessage(*, header: AmqpMessageHeader | Mapping[str, Any] | None = None, footer: Dict[str, Any] | None = None, properties: AmqpMessageProperties | Mapping[str, Any] | None = None, application_properties: Dict[str, Any] | None = None, annotations: Dict[str, Any] | None = None, delivery_annotations: Dict[str, Any] | None = None, **kwargs: Any)

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

名前 説明
data_body
str または bytes または list[str または bytes]

本文は 1 つ以上のデータ セクションで構成され、各セクションには不透明なバイナリ データが含まれています。
sequence_body
list[any]

本文は 1 つ以上のシーケンス セクションで構成され、各セクションには任意の数の構造化データ要素が含まれています。
value_body
any

本文は 1 つの amqp-value セクションで構成され、セクションには 1 つの AMQP 値が含まれています。
header
AmqpMessageHeader または <xref:mapping>[str, any] または None

amqp メッセージ ヘッダー。
footer
dict または None

amqp メッセージ フッター。
properties
AmqpMessageProperties または <xref:mapping>[str, any] または None

amqp メッセージに追加するプロパティ。
application_properties
dict または None

サービス固有のアプリケーション プロパティ。
annotations
dict または None

サービス固有のメッセージ注釈。
delivery_annotations
dict または None

サービス固有の配信注釈。

属性

annotations

サービス固有のメッセージ注釈。

戻り値

型 説明
Optional[Dict]

application_properties

サービス固有のアプリケーション プロパティ。

戻り値

型 説明
Optional[Dict]

body

メッセージの本文。 形式は本文の種類によって異なる場合があります。~azure.servicebus.AmqpMessageBodyType.DATA の場合、本文はバイトまたは Iterable[bytes] ~azure.servicebus.AmqpMessageBodyType.SEQUENCE の場合、本文は List または Iterable[List] For ~azure.servicebus.AmqpMessageBodyType.VALUE で、本文は任意の型にすることができます。 :rtype: Any

body_type

基になる AMQP メッセージの本文の種類。 rtype: ~azure.servicebus.amqp.AmqpMessageBodyType

delivery_annotations

メッセージの先頭にある配信固有の非標準プロパティ。 配信注釈は、送信側ピアから受信側ピアに情報を伝達します。

戻り値

型 説明
Dict

メッセージ フッター。

戻り値

型 説明
Optional[Dict]

header

メッセージ ヘッダー。 :rtype: Optional[~azure.servicebus.amqp.AmqpMessageHeader]

properties

メッセージに追加するプロパティ。 :rtype: Optional[~azure.servicebus.amqp.AmqpMessageProperties]