SubscriptionDescription クラス

  • リファレンス
パッケージ:
com.microsoft.azure.servicebus.management
Maven 成果物:
com.microsoft.azure:azure-servicebus:3.6.7
  • java.lang.Object
    • com.microsoft.azure.servicebus.management.UnknownPropertiesHolder
      • com.microsoft.azure.servicebus.management.SubscriptionDescription

public class SubscriptionDescription
extends com.microsoft.azure.servicebus.management.UnknownPropertiesHolder

サブスクリプションのメタデータの説明を表します。

コンストラクターの概要

コンストラクター 説明
SubscriptionDescription(String topicPath, String subscriptionName)

指定した相対パスを使用して、サブスクリプションの説明の新しいインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
boolean equals(Object o)
Duration getAutoDeleteOnIdle()
Duration getDefaultMessageTimeToLive()

Time-To-Live は、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。
EntityStatus getEntityStatus()

エンティティの状態を取得します。
String getForwardDeadLetteredMessagesTo()
String getForwardTo()
Duration getLockDuration()

他の受信者が同じメッセージを受信しないように、特定の受信者によってメッセージがロックされる時間。
int getMaxDeliveryCount()

配信不能になる前のメッセージの最大配信数。
String getPath()
String getSubscriptionName()
String getTopicPath()
String getUserMetadata()
int hashCode()
boolean isEnableBatchedOperations()
boolean isEnableDeadLetteringOnFilterEvaluationException()
boolean isEnableDeadLetteringOnMessageExpiration()

メッセージの有効期限が切れたときに、このサブスクリプションが配信不能サポートを持っているかどうかを示します。
boolean isRequiresSession()
void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void setEnableBatchedOperations(boolean enableBatchedOperations)
void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)
void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
void setEntityStatus(EntityStatus status)
void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
void setForwardTo(String forwardTo)
void setLockDuration(Duration lockDuration)

他の受信者が同じメッセージを受信しないように、特定の受信者によってメッセージがロックされる時間を設定します。
void setMaxDeliveryCount(int maxDeliveryCount)

配信不能になる前のメッセージの最大配信数。
void setRequiresSession(boolean requiresSession)
void setUserMetadata(String userMetadata)

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

SubscriptionDescription

public SubscriptionDescription(String topicPath, String subscriptionName)

指定した相対パスを使用して、SubscriptionDescription の新しいインスタンスを初期化します。

パラメーター:

topicPath -
  • トピックの最大長のパスは 260 文字です。 スラッシュで開始または終了することはできません。 '@','?','#','*' という制限付き文字を使用できません。
subscriptionName -
  • サブスクリプションの最大長は 50 文字です。 '@','?','#','*','/' という制限付き文字を使用できません。

メソッドの詳細

equals

public boolean equals(Object o)

上書き:

SubscriptionDescription.equals(Object o)

パラメーター:

o

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

戻り値:

サブスクリプションが自動的に削除されるアイドル間隔。 既定値は MAX_DURATION です

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Time-To-Live は、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、 がメッセージ自体に設定されていない場合 getTimeToLive() に使用される既定値です。 その TimeToLive の値よりも古いメッセージは期限切れになり、メッセージ ストアに保持されません。 サブスクライバーは期限切れのメッセージを受け取れなくなります。

戻り値:

メッセージの既定の有効期間の値。 既定値は MAX_DURATION です

getEntityStatus

public EntityStatus getEntityStatus()

エンティティの状態を取得します。 エンティティが無効になっている場合、そのエンティティはメッセージを送受信できません。

戻り値:

キューの現在の状態 (有効/無効)。 既定値は Enabled です。

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

戻り値:

このサブスクリプションのすべての配信不能メッセージの転送先となる受信者エンティティのパス。 設定されている場合、ユーザーはこのサブスクリプションから配信不能メッセージを手動で受信できません。 宛先エンティティは既に存在している必要があります。

getForwardTo

public String getForwardTo()

戻り値:

サブスクリプションに送信されたすべてのメッセージの転送先となる受信者エンティティのパス。 設定されている場合、ユーザーはこのサブスクリプションからメッセージを手動で受信できません。 変換先エンティティは、既に既存のエンティティである必要があります。

getLockDuration

public Duration getLockDuration()

他の受信者が同じメッセージを受信しないように、特定の受信者によってメッセージがロックされる時間。

戻り値:

ピーク ロックの期間。 既定値は 60 秒です。

getMaxDeliveryCount

public int getMaxDeliveryCount()

配信不能になる前のメッセージの最大配信数。 メッセージがモードで PEEKLOCK 受信され、メッセージ ロックの有効期限が切れる前にメッセージが完了しなかった場合、配信数が増えます。

戻り値:

既定値は 10 です。

getPath

public String getPath()

戻り値:

トピックを含むサブスクリプションのパス。

getSubscriptionName

public String getSubscriptionName()

戻り値:

サブスクリプション名。

getTopicPath

public String getTopicPath()

戻り値:

トピックのパス。

getUserMetadata

public String getUserMetadata()

戻り値:

ユーザーが説明に関連付けることができるカスタム metdata。

hashCode

public int hashCode()

上書き:

SubscriptionDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

戻り値:

サーバー側のバッチ処理操作が有効かどうかを示します。 既定値は true です。

isEnableDeadLetteringOnFilterEvaluationException

public boolean isEnableDeadLetteringOnFilterEvaluationException()

戻り値:

ブール値は、サブスクリプション ルールの評価が失敗したときにメッセージを配信不能サブキューに転送する必要があるかどうかを示します。 既定値は true です。

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

メッセージの有効期限が切れたときに、このサブスクリプションが配信不能サポートを持っているかどうかを示します。

戻り値:

true の場合、期限切れのメッセージは配信不能サブキューに移動されます。 既定値は false です。

isRequiresSession

public boolean isRequiresSession()

戻り値:

これは、サブスクリプションがセッションの概念をサポートしているかどうかを示します。 セッションフル メッセージは FIFO の順序に従います。

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

パラメーター:

autoDeleteOnIdle -
  • サブスクリプションが自動的に削除されるアイドル間隔。 最小時間は、5 分です。

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

パラメーター:

defaultMessageTimeToLive -
  • 既定のメッセージ時間をライブ値に設定します。 値を 1 秒未満にすることはできません。 「getDefaultMessageTimeToLive()」を参照してください。

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

パラメーター:

enableBatchedOperations -
  • サーバー側のバッチ処理操作が有効かどうかを示します。

setEnableDeadLetteringOnFilterEvaluationException

public void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)

パラメーター:

enableDeadLetteringOnFilterEvaluationException -

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

パラメーター:

enableDeadLetteringOnMessageExpiration -

setEntityStatus

public void setEntityStatus(EntityStatus status)

パラメーター:

status -
  • キューの状態 (有効/無効)。 エンティティが無効になっている場合、そのエンティティはメッセージを送受信できません。

setForwardDeadLetteredMessagesTo

public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

パラメーター:

forwardDeadLetteredMessagesTo -
  • このサブスクリプションのすべての配信不能メッセージの転送先となる受信者エンティティのパス。 設定されている場合、ユーザーはこのサブスクリプションから配信不能メッセージを手動で受信できません。 宛先エンティティは既に存在している必要があります。

setForwardTo

public void setForwardTo(String forwardTo)

パラメーター:

forwardTo -
  • サブスクリプションに送信されたすべてのメッセージの転送先となる受信者エンティティのパス。 設定されている場合、ユーザーはこのサブスクリプションからメッセージを手動で受信できません。 変換先エンティティは、既に既存のエンティティである必要があります。

setLockDuration

public void setLockDuration(Duration lockDuration)

他の受信者が同じメッセージを受信しないように、特定の受信者によってメッセージがロックされる時間を設定します。

パラメーター:

lockDuration -
  • ピーク ロックの期間。 最大値は 5 分です。

setMaxDeliveryCount

public void setMaxDeliveryCount(int maxDeliveryCount)

配信不能になる前のメッセージの最大配信数。 メッセージがモードで PEEKLOCK 受信され、メッセージ ロックの有効期限が切れる前にメッセージが完了しなかった場合、配信数が増えます。

パラメーター:

maxDeliveryCount -
  • 最大値は 1 です。

setRequiresSession

public void setRequiresSession(boolean requiresSession)

パラメーター:

requiresSession -
  • サブスクリプションでセッションをサポートする必要がある場合は、true に設定します。

setUserMetadata

public void setUserMetadata(String userMetadata)

パラメーター:

userMetadata -
  • ユーザーが説明に関連付けることができるカスタム metdata。 null にすることはできません。 最大長は 1024 文字です

適用対象