ServiceBusReceivedMessage クラス

パッケージ:

com.azure.messaging.servicebus

Maven 成果物:

com.azure:azure-messaging-servicebus:7.17.0

• java.lang.Object
• • com.azure.messaging.servicebus.ServiceBusReceivedMessage

public final class ServiceBusReceivedMessage

Service Bus から受信したメッセージをカプセル化するデータ構造。 メッセージ構造については、 製品ドキュメントで詳しく説明します。

メソッドの概要

修飾子と型	メソッドと説明
Map<String,Object>	getApplicationProperties() Service Bus 操作中に に関連付けられているメタデータを渡すために使用できる自由形式 ServiceBusReceivedMessage のプロパティのセットを ServiceBusReceivedMessage 取得します。
BinaryData	getBody() によってラップされたペイロードを取得します ServiceBusReceivedMessage。
String	getContentType() メッセージのコンテンツ タイプを取得します。
String	getCorrelationId() 関連付け識別子を取得します。
String	getDeadLetterErrorDescription() 配信不能になったメッセージの説明を取得します。
String	getDeadLetterReason() メッセージが配信不能になった理由を取得します。
String	getDeadLetterSource() このメッセージが配信不能になる前にエンキューされたキューまたはサブスクリプションの名前を取得します。
long	getDeliveryCount() このメッセージがクライアントに配信された回数を取得します。
long	getEnqueuedSequenceNumber() Service Bus によってメッセージに割り当てられたエンキューされたシーケンス番号を取得します。
OffsetDateTime	getEnqueuedTime() このメッセージがAzure Service Busでエンキューされた日時を取得します。
OffsetDateTime	getExpiresAt() このメッセージの有効期限が切れる日時を取得します。
String	getLockToken() 現在のメッセージのロック トークンを取得します。
OffsetDateTime	getLockedUntil() このメッセージのロックの有効期限が切れる日時を取得します。
String	getMessageId() メッセージの識別子を取得します。
String	getPartitionKey() パーティション分割されたエンティティにメッセージを送信するためのパーティション キーを取得します。
AmqpAnnotatedMessage	getRawAmqpMessage() AMQP プロトコルによって定義されたメッセージの表現。
String	getReplyTo() 返信を送信するエンティティのアドレスを取得します。
String	getReplyToSessionId() アドレスを拡張するセッション識別子を getReplyTo() 取得または設定します。
OffsetDateTime	getScheduledEnqueueTime() このメッセージのスケジュールされたエンキュー時間を取得します。
long	getSequenceNumber() Service Bus によってメッセージに割り当てられた一意の番号を取得します。
String	getSessionId() メッセージのセッション ID を取得します。
ServiceBusMessageState	getState() メッセージの状態を取得します。
String	getSubject() メッセージの件名を取得します。
Duration	getTimeToLive() このメッセージの有効期限が切れるまでの期間を取得します。
String	getTo() "to" アドレスを取得します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

メソッドの詳細

getApplicationProperties

public Map getApplicationProperties()

Service Bus 操作中に に関連付けられているメタデータを渡すために使用できる自由形式 ServiceBusReceivedMessage のプロパティのセットを ServiceBusReceivedMessage 取得します。 の一般的なユース ケース properties() は、 のシリアル化ヒント getBody() を、バイナリ データの逆シリアル化を希望するコンシューマーに支援として関連付ける方法です。

Returns:

この ServiceBusReceivedMessageに関連付けられているアプリケーション プロパティ。

getBody

public BinaryData getBody()

によってラップされたペイロードを取得します ServiceBusReceivedMessage。

は BinaryData バイト配列をラップし、さまざまな表現方法に対する抽象化です。 オブジェクトをシリアル化/逆シリアル化するための便利な API が提供されます。

生データを逆シリアル化する手段がコンシューマーに明らかでない場合、一般的な手法は、イベントの getApplicationProperties() 作成時に を利用して、バイナリ データを逆シリアル化するコンシューマーの支援としてシリアル化ヒントを関連付ける方法です。

Returns:

ペイロードを表すバイナリ データ。

getContentType

public String getContentType()

メッセージのコンテンツ タイプを取得します。

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

Returns:

の contentType ServiceBusReceivedMessage。

getCorrelationId

public String getCorrelationId()

関連付け識別子を取得します。

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

Returns:

このメッセージの関連付け ID。

getDeadLetterErrorDescription

public String getDeadLetterErrorDescription()

配信不能になったメッセージの説明を取得します。

Returns:

配信不能メッセージの説明。 null それ以外の場合は 。

getDeadLetterReason

public String getDeadLetterReason()

メッセージが配信不能になった理由を取得します。

Returns:

メッセージが配信不能になった理由。 null それ以外の場合は 。

getDeadLetterSource

public String getDeadLetterSource()

このメッセージが配信不能になる前にエンキューされたキューまたはサブスクリプションの名前を取得します。

この値は、配信不能になり、その後配信不能キューから別のエンティティに自動転送されたメッセージでのみ設定されます。

Returns:

メッセージが配信不能になったエンティティ。 null それ以外の場合は 。

getDeliveryCount

public long getDeliveryCount()

このメッセージがクライアントに配信された回数を取得します。

このカウントは、メッセージのロックが有効期限切れになった場合、またはメッセージが受信者によって明示的に破棄された場合に増分されます。

Returns:

このメッセージの配信数。

getEnqueuedSequenceNumber

public long getEnqueuedSequenceNumber()

Service Bus によってメッセージに割り当てられたエンキューされたシーケンス番号を取得します。

シーケンス番号は、最初の送信時点で受け入れられるメッセージに最初に割り当てられる一意の 64 ビット整数です。

Returns:

このメッセージのエンキューされたシーケンス番号

getEnqueuedTime

public OffsetDateTime getEnqueuedTime()

このメッセージがAzure Service Busでエンキューされた日時を取得します。

メッセージが受け入れられ、エンティティに格納されている UTC 日時。 スケジュールされたメッセージの場合、メッセージがアクティブ化された時刻が反映されます。 この値は、受信者が送信者の時計を信頼したくない場合に、信頼できる中立的な到着時間インジケーターとして使用できます。

Returns:

メッセージがAzure Service Busにエンキューされた日時。

getExpiresAt

public OffsetDateTime getExpiresAt()

このメッセージの有効期限が切れる日時を取得します。

値は、メッセージの削除がスケジュールされ、エンティティからの取得ができなくなります。 有効期限は、 プロパティによって制御されます getTimeToLive() 。 このプロパティは、 と getTimeToLive()からgetEnqueuedTime()計算されます。

Returns:

OffsetDateTimeこのメッセージの有効期限が切れる 。

getLockToken

public String getLockToken()

現在のメッセージのロック トークンを取得します。

ロック トークンは、ブローカーがモードで PEEK_LOCK 保持しているロックへの参照です。 ロックは、 製品ドキュメントで説明されているように、メッセージを明示的に解決するために使用されます。 また、このトークンを使用して 、Deferral API を介してロックを永続的にピン留めし、メッセージを通常の配信状態フローから取り出すこともできます。 このプロパティは読み取り専用です。

Returns:

このメッセージのロック トークン。 null モードを使用して RECEIVE_AND_DELETE 取得されたメッセージの場合は 。

getLockedUntil

public OffsetDateTime getLockedUntil()

このメッセージのロックの有効期限が切れる日時を取得します。

ロックの下で取得されたメッセージ (事前決済ではなくピーク ロック受信モード) の場合、このプロパティは、メッセージがキュー/サブスクリプションでロックされるまでの UTC 日時を反映します。 ロックの有効期限が切れると、 がインクリメントされ、 getDeliveryCount() メッセージが再び取得できるようになります。 このプロパティは読み取り専用です。

Returns:

モードを使用して PEEK_LOCK メッセージを受信した場合に、このメッセージのロックが期限切れになる日時。 それ以外の場合は null を返します。

getMessageId

public String getMessageId()

メッセージの識別子を取得します。

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

Returns:

の ServiceBusReceivedMessageID。

getPartitionKey

public String getPartitionKey()

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

パーティション分割されたエンティティの場合、この値を設定すると、関連するメッセージを同じ内部パーティションに割り当てて、送信順序が正しく記録されるようにできます。 パーティションはハッシュ関数でこの値を介して選択され、直接選択することはできません。 セッション対応エンティティの場合、 プロパティはこの getSessionId() 値をオーバーライドします。

Returns:

このメッセージのパーティション キー。

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

AMQP プロトコルによって定義されたメッセージの表現。

Returns:

AmqpAnnotatedMessage AMQP メッセージを表す 。

getReplyTo

public String getReplyTo()

返信を送信するエンティティのアドレスを取得します。

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

Returns:

このメッセージの ReplyTo プロパティ値

getReplyToSessionId

public String getReplyToSessionId()

アドレスを拡張するセッション識別子を getReplyTo() 取得または設定します。

この値は、ReplyTo の情報を補足し、応答が応答エンティティに送信されるときに設定する必要がある SessionId を指定します。

Returns:

このメッセージの ReplyToSessionId プロパティ値

getScheduledEnqueueTime

public OffsetDateTime getScheduledEnqueueTime()

このメッセージのスケジュールされたエンキュー時間を取得します。

この値は、遅延メッセージの可用性に使用されます。 メッセージはキューに安全に追加されますが、アクティブとは見なされないため、スケジュールされたエンキュー時間まで取得できません。 指定された日時にメッセージがアクティブ化 (エンキュー) されないことに注意してください。実際のアクティブ化時間は、キューのワークロードとその状態によって異なります。

Returns:

Azure Service Busでメッセージがエンキューされる日時

getSequenceNumber

public long getSequenceNumber()

Service Bus によってメッセージに割り当てられた一意の番号を取得します。

このシーケンス番号は、メッセージがブローカーおよび関数によって受け入れおよび格納されるときに真の識別子として割り当てられる 64 ビットの整数です。 パーティション分割されたエンティティの場合、最上位の 16 ビットはパーティション識別子を表します。 シーケンス番号はギャップなしで単調に増分されます。 48 - 64 ビット範囲が使い果たされると、0 にロールオーバーされます。 このプロパティは読み取り専用です。

Returns:

このメッセージのシーケンス番号

getSessionId

public String getSessionId()

メッセージのセッション ID を取得します。

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

Returns:

のセッション ID ServiceBusReceivedMessage。

getState

public ServiceBusMessageState getState()

メッセージの状態を取得します。 メッセージの状態は、Active、Deferred、または Scheduled のいずれかです。 遅延メッセージには遅延状態があり、スケジュールされたメッセージにはスケジュールされた状態があり、他のすべてのメッセージはアクティブ状態です。

Returns:

メッセージの状態。

getSubject

public String getSubject()

メッセージの件名を取得します。

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

Returns:

メッセージの件名。

getTimeToLive

public Duration getTimeToLive()

このメッセージの有効期限が切れるまでの期間を取得します。

この値は、 でキャプチャ getScheduledEnqueueTime()されたとおりに、メッセージがブローカーによって受け入れられ、格納された日時から、メッセージが期限切れになるまでの相対的な期間です。 明示的に設定しない場合、想定される値は、それぞれのキューまたはトピックに設定された DefaultTimeToLive です。 メッセージレベルの TimeToLive 値をエンティティの DefaultTimeToLive の設定より長くすることはできません。長くした場合、自動的に調整されます。

Returns:

このメッセージの有効期間

getTo

public String getTo()

"to" アドレスを取得します。

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

Returns:

このメッセージの "To" プロパティ値