QueueDescription クラス

  • リファレンス
パッケージ:
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.QueueDescription

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

キューのメタデータの説明を表します。

コンストラクターの概要

コンストラクター 説明
QueueDescription(String path)

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

メソッドの概要

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

Time-To-Live は、メッセージが Service Bus に送信された時点から、メッセージの有効期限が切れる期間です。
Duration getDuplicationDetectionHistoryTimeWindow()
EntityStatus getEntityStatus()

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

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

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

メッセージの有効期限が切れたときに、このキューに配信不能のサポートがあるかどうかを示します。
boolean isEnablePartitioning()
boolean isRequiresDuplicateDetection()

有効にすると、 の期間内#getDuplicationDetectionHistoryTimeWindowに同じgetMessageId()メッセージがキューに送信された重複メッセージは破棄されます。
boolean isRequiresSession()
void setAuthorizationRules(List<AuthorizationRule> authorizationRules)
void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
void setEnableBatchedOperations(boolean enableBatchedOperations)
void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
void setEnablePartitioning(boolean enablePartitioning)
void setEntityStatus(EntityStatus status)
void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
void setForwardTo(String forwardTo)
void setLockDuration(Duration lockDuration)

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

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

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

QueueDescription

public QueueDescription(String path)

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

パラメーター:

path -
  • トピックのパス。 最大長は 260 文字です。 スラッシュで開始または終了することはできません。 制限付き文字を使用できません: '@','?','#','*'

メソッドの詳細

equals

public boolean equals(Object o)

上書き:

QueueDescription.equals(Object o)

パラメーター:

o

getAuthorizationRules

public List getAuthorizationRules()

戻り値:

AuthorizationRuleエンティティ レベルでユーザー アクセスを制御するキューの 。

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

戻り値:

キューが自動的に削除されるアイドル間隔。 既定値は MAX_DURATION です

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

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

戻り値:

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

getDuplicationDetectionHistoryTimeWindow

public Duration getDuplicationDetectionHistoryTimeWindow()

戻り値:

サービスによって維持される重複検出履歴の期間。 既定値は 1 分です。

getEntityStatus

public EntityStatus getEntityStatus()

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

戻り値:

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

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

戻り値:

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

getForwardTo

public String getForwardTo()

戻り値:

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

getLockDuration

public Duration getLockDuration()

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

戻り値:

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

getMaxDeliveryCount

public int getMaxDeliveryCount()

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

戻り値:

既定値は 10 です。

getMaxSizeInMB

public long getMaxSizeInMB()

戻り値:

キューの最大サイズをメガバイト単位で指定します。これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。

getPath

public String getPath()

戻り値:

キューのパスです。

getUserMetadata

public String getUserMetadata()

戻り値:

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

hashCode

public int hashCode()

上書き:

QueueDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

戻り値:

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

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

メッセージの有効期限が切れたときに、このキューに配信不能のサポートがあるかどうかを示します。

戻り値:

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

isEnablePartitioning

public boolean isEnablePartitioning()

戻り値:

キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示すブール値。 既定値は false

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

有効にすると、 の期間内#getDuplicationDetectionHistoryTimeWindowに同じgetMessageId()メッセージがキューに送信された重複メッセージは破棄されます。

戻り値:

キューで重複するメッセージに対する保護が必要かどうかを示す 値。

isRequiresSession

public boolean isRequiresSession()

戻り値:

キューがセッションの概念をサポートしているかどうかを示す boolean。 セッションフル メッセージは FIFO の順序に従います。

setAuthorizationRules

public void setAuthorizationRules(List authorizationRules)

パラメーター:

authorizationRules -
  • AuthorizationRuleエンティティ レベルでユーザー アクセスを制御するキューの 。

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

パラメーター:

autoDeleteOnIdle -
  • キューが自動的に削除されるアイドル間隔。 最小時間は、5 分です。

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

パラメーター:

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

setDuplicationDetectionHistoryTimeWindow

public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)

パラメーター:

duplicationDetectionHistoryTimeWindow -
  • サービスによって維持される重複検出履歴の期間。 最大値は 1 日で、最小値は 20 秒です。

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

パラメーター:

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

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

パラメーター:

enableDeadLetteringOnMessageExpiration -

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

パラメーター:

enablePartitioning -
  • キューを複数のメッセージ ブローカー間でパーティション分割する場合は true。

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 です。

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

パラメーター:

maxSize -
  • キューの最大サイズ (メガバイト単位)。 これは、キューに割り当てられたメモリのサイズです。

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

パラメーター:

requiresDuplicateDetection -

setRequiresSession

public void setRequiresSession(boolean requiresSession)

パラメーター:

requiresSession -
  • キューでセッションをサポートする必要がある場合は True です。

setUserMetadata

public void setUserMetadata(String userMetadata)

パラメーター:

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

適用対象