ServiceBusMessage クラス

  • リファレンス

Service Bus メッセージ。

継承
builtins.object
ServiceBusMessage

コンストラクター

ServiceBusMessage(body: str | bytes | None, *, application_properties: Dict[str | bytes, int | float | bytes | bool | str | UUID] | None = None, session_id: str | None = None, message_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, time_to_live: timedelta | None = None, content_type: str | None = None, correlation_id: str | None = None, subject: str | None = None, partition_key: str | None = None, to: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, **kwargs: Any)

パラメーター

body
Optional[Union[str, bytes]]
必須

1 つのメッセージで送信するデータ。

application_properties
Dict[str, Union[int または float または bool または bytes または str または UUID または datetime または None]]

メッセージのユーザー定義プロパティ。

session_id
Optional[str]

セッションフル エンティティのメッセージのセッション識別子。

message_id
Optional[str]

メッセージを識別する ID。

scheduled_enqueue_time_utc
Optional[datetime]

メッセージへの utc スケジュールされたエンキュー時間。

time_to_live
Optional[timedelta]

メッセージの有効期間。

content_type
Optional[str]

コンテンツ タイプ記述子。

correlation_id
Optional[str]

関連付け識別子。

subject
Optional[str]

アプリケーション固有の件名。ラベルと呼ばれることもあります。

partition_key
Optional[str]

パーティション分割されたエンティティにメッセージを送信するためのパーティション キー。

to
Optional[str]

auto_forwardチェーン シナリオに使用 されるアドレス指定 する 。

reply_to
Optional[str]

返信の送信先のエンティティのアドレス。

reply_to_session_id
Optional[str]

reply_to アドレスを拡張するセッション識別子。

例

追加のプロパティを含むメッセージの送信


   message_send = ServiceBusMessage(
       "Hello World!!",
       session_id="MySessionID",
       application_properties={'data': 'custom_data'},
       time_to_live=datetime.timedelta(seconds=30),
       label='MyLabel'
   )

属性

application_properties

メッセージのユーザー定義プロパティ。

の戻り値の型 :

dict[str,
bytes, <xref:PrimitiveTypes>],
None

body

メッセージの本文。 形式は、本文の種類によって異なる場合があります。 の場合 DATA、本文はバイトまたは Iterable[bytes] になります。 の場合 SEQUENCE、本文は List または Iterable[List]になります。 の場合 VALUE、本文には任意の型を指定できます。

の戻り値の型 :

Any

body_type

基になる AMQP メッセージの本文の種類。

の戻り値の型 :

AmqpMessageBodyType

content_type

コンテンツ タイプ記述子。

必要に応じて、メッセージのペイロードを記述します。記述子は、"application/json" など、RFC2045セクション 5 の形式に従います。

の戻り値の型 :

str,
None

correlation_id

関連付け識別子。

相関関係のために、アプリケーションがメッセージのコンテキストを指定できるようにします (たとえば、応答されるメッセージの MessageId を示すなど)。

の「メッセージ ルーティングと関連付け」を https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation参照してください。

の戻り値の型 :

str,
None

message

基になる uamqp を取得します。Message または LegacyMessage。 これは非推奨であり、今後のリリースで削除される予定です。

の戻り値の型 :

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

message_id

メッセージを識別する ID。

メッセージ識別子は、アプリケーションによって定義される、メッセージとそのペイロードを一意に識別する値です。 この識別子は自由形式の文字列で、GUID またはアプリケーションのコンテキストから派生した識別子を反映することができます。 有効にした場合、重複検出 (参照 https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) 機能は、同じメッセージ ID を持つメッセージの 2 つ目以降の送信を識別して削除します。

の戻り値の型 :

str,
None

partition_key

パーティション分割されたエンティティにメッセージを送信するためのパーティション キー。

この値を設定すると、関連するメッセージを同じ内部パーティションに割り当てることが可能になり、送信シーケンスの順序が正しく記録されます。 パーティションはハッシュ関数でこの値を介して選択され、直接選択することはできません。

の「パーティション分割されたキューとトピック」を https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning参照してください。

の戻り値の型 :

str,
None

raw_amqp_message

高度な使用のみ。 送受信される内部 AMQP メッセージ ペイロード。 :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

返信の送信先のエンティティのアドレス。

これはアプリケーションによって定義される省略可能な値であり、メッセージの受信者への応答パスを表す標準的な方法です。 応答が必要な場合、送信者は、この値を応答の送信先にするキューまたはトピックの絶対または相対パスに設定します。

の「メッセージ ルーティングと関連付け」を https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation参照してください。

の戻り値の型 :

str,
None

reply_to_session_id

reply_to アドレスを拡張するセッション識別子。

この値は 、reply_to 情報を拡張し、応答エンティティに送信するときに応答に設定するセッション ID を指定します。

の「メッセージ ルーティングと関連付け」を https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation参照してください。

の戻り値の型 :

str,
None

scheduled_enqueue_time_utc

メッセージへの utc スケジュールされたエンキュー時間。

このプロパティは、 ServiceBusSender.send メソッドを使用してメッセージを送信する際のスケジュール設定に使用できます。 スケジュールされたメッセージを取り消す必要がある場合は、 ServiceBusSender.schedule メソッドを使用する必要があります。このメソッドは、将来の取り消しに使用できるシーケンス番号を返します。 設定されていない場合、scheduled_enqueue_time_utcは None です。

の戻り値の型 :

datetime

session_id

セッションフル エンティティのメッセージのセッション識別子。

セッションフル エンティティの場合、このアプリケーション定義値はメッセージのセッションアフィリエーションを指定します。 同じセッション識別子を持つメッセージがまとめてロックされ、正確な順序での処理と多重化が可能になります。 セッションフルでないエンティティの場合、この値は無視されます。

のメッセージ セッションに関するページを https://docs.microsoft.com/azure/service-bus-messaging/message-sessions参照してください。

の戻り値の型 :

str,
None

subject

アプリケーション固有の件名。ラベルと呼ばれることもあります。

このプロパティを使用すると、アプリケーションは、電子メールの件名行と同様に標準化された方法でメッセージの目的を受信者に示すことができます。

の戻り値の型 :

str

time_to_live

メッセージの有効期間。

この値は、メッセージの有効期限が切れるまでの相対的な期間です。これは、メッセージが受け入れられ、ブローカーによって格納された時点から始まり、 enqueued_time_utcでキャプチャされます。 明示的に設定しない場合、それぞれのキューまたはトピックの DefaultTimeToLive が値として見なされます。 メッセージ レベルの time-to-live 値はエンティティの Time-to-Live 設定より長くすることはできません。その場合は、自動的に調整されます。

「有効期限」を参照してください https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

の戻り値の型 :

timedelta

to

アドレス 指定する 。

このプロパティはルーティング　シナリオでの将来の使用のために予約されており、現在はブローカー自体で無視されます。 アプリケーションは、ルールに基づく自動転送チェーンのシナリオでこの値を使用して、メッセージの目的の論理送信先を示すことができます。

詳細については、 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding をご覧ください。

の戻り値の型 :

str,
None