QueueDescription クラス
- java.
lang. Object - com.
microsoft. azure. servicebus. management. UnknownPropertiesHolder - com.
microsoft. azure. servicebus. management. QueueDescription
- com.
- com.
public class QueueDescription
extends com.microsoft.azure.servicebus.management.UnknownPropertiesHolder
キューのメタデータの説明を表します。
コンストラクターの概要
| コンストラクター | 説明 |
|---|---|
| QueueDescription(String path) |
指定した相対パスを使用して、Queue |
メソッドの概要
メソッドの継承元: java.lang.Object
コンストラクターの詳細
QueueDescription
public QueueDescription(String path)
指定した相対パスを使用して QueueDescription の新しいインスタンスを初期化します。
パラメーター:
- トピックのパス。 最大長は 260 文字です。 スラッシュで開始または終了することはできません。 制限付き文字を使用できません: '@','?','#','*'
メソッドの詳細
equals
public boolean equals(Object o)
上書き:
QueueDescription.equals(Object o)パラメーター:
getAuthorizationRules
getAutoDeleteOnIdle
getDefaultMessageTimeToLive
public Duration getDefaultMessageTimeToLive()
Time-To-Live は、メッセージが Service Bus に送信された時点から、メッセージの有効期限が切れる期間です。 これは、メッセージ自体に が設定されていない場合 getTimeToLive() に使用される既定値です。 その TimeToLive の値よりも古いメッセージは期限切れになり、メッセージ ストアに保持されません。 サブスクライバーは期限切れのメッセージを受け取れなくなります。
戻り値:
getDuplicationDetectionHistoryTimeWindow
public Duration getDuplicationDetectionHistoryTimeWindow()
戻り値:
getEntityStatus
public EntityStatus getEntityStatus()
エンティティの状態を取得します。 エンティティが無効になっている場合、そのエンティティはメッセージを送受信できません。
戻り値:
getForwardDeadLetteredMessagesTo
public String getForwardDeadLetteredMessagesTo()
戻り値:
getForwardTo
public String getForwardTo()
戻り値:
getLockDuration
public Duration getLockDuration()
他の受信者が同じメッセージを受信しないように、メッセージが特定の受信者によってロックされている時間。
戻り値:
getMaxDeliveryCount
public int getMaxDeliveryCount()
配信不能になる前のメッセージの最大配信数。 メッセージがモードで PEEKLOCK 受信され、メッセージ ロックの有効期限が切れる前にメッセージが完了しなかった場合、配信数が増えます。
戻り値:
getMaxSizeInMB
public long getMaxSizeInMB()
戻り値:
getPath
public String getPath()
戻り値:
getUserMetadata
public String getUserMetadata()
戻り値:
hashCode
public int hashCode()
上書き:
QueueDescription.hashCode()isEnableBatchedOperations
public boolean isEnableBatchedOperations()
戻り値:
isEnableDeadLetteringOnMessageExpiration
public boolean isEnableDeadLetteringOnMessageExpiration()
メッセージの有効期限が切れたときに、このキューに配信不能のサポートがあるかどうかを示します。
戻り値:
isEnablePartitioning
public boolean isEnablePartitioning()
戻り値:
isRequiresDuplicateDetection
public boolean isRequiresDuplicateDetection()
有効にすると、 の期間内#getDuplicationDetectionHistoryTimeWindowに同じgetMessageId()メッセージがキューに送信された重複メッセージは破棄されます。
戻り値:
isRequiresSession
public boolean isRequiresSession()
戻り値:
setAuthorizationRules
public void setAuthorizationRules(List
パラメーター:
- AuthorizationRuleエンティティ レベルでユーザー アクセスを制御するキューの 。
setAutoDeleteOnIdle
public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
パラメーター:
- キューが自動的に削除されるアイドル間隔。 最小時間は、5 分です。
setDefaultMessageTimeToLive
public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
パラメーター:
- ライブ値への既定のメッセージ時間。 値を 1 秒未満にすることはできません。 「getDefaultMessageTimeToLive()」を参照してください。
setDuplicationDetectionHistoryTimeWindow
public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
パラメーター:
- サービスによって維持される重複検出履歴の期間。 最大値は 1 日で、最小値は 20 秒です。
setEnableBatchedOperations
public void setEnableBatchedOperations(boolean enableBatchedOperations)
パラメーター:
- サーバー側のバッチ処理操作が有効かどうかを示します。
setEnableDeadLetteringOnMessageExpiration
public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
パラメーター:
- True を指定すると、メッセージの有効期限が切れた場合に配信不能になります。 「isEnableDeadLetteringOnMessageExpiration()」を参照してください。
setEnablePartitioning
public void setEnablePartitioning(boolean enablePartitioning)
パラメーター:
- キューを複数のメッセージ ブローカー間でパーティション分割する場合は true。
setEntityStatus
public void setEntityStatus(EntityStatus status)
パラメーター:
- キューの状態 (有効/無効)。 エンティティが無効になっている場合、そのエンティティはメッセージを送受信できません。
setForwardDeadLetteredMessagesTo
public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
パラメーター:
- このキューのすべての配信不能メッセージの転送先となる受信者エンティティのパス。 設定されている場合、ユーザーはこのキューから配信不能メッセージを手動で受信できません。 宛先エンティティは既に存在している必要があります。
setForwardTo
public void setForwardTo(String forwardTo)
パラメーター:
- キューに送信されたすべてのメッセージの転送先となる受信者エンティティのパス。 設定されている場合、ユーザーはこのキューからメッセージを手動で受信できません。 変換先エンティティは、既に既存のエンティティである必要があります。
setLockDuration
public void setLockDuration(Duration lockDuration)
他の受信者が同じメッセージを受信しないように、特定の受信者によってメッセージがロックされる時間を設定します。
パラメーター:
- ピーク ロックの期間。 最大値は 5 分です。
setMaxDeliveryCount
public void setMaxDeliveryCount(int maxDeliveryCount)
配信不能になる前のメッセージの最大配信数。 メッセージがモードで PEEKLOCK 受信され、メッセージ ロックの有効期限が切れる前にメッセージが完了しなかった場合、配信数が増えます。
パラメーター:
- 最大値は 1 です。
setMaxSizeInMB
public void setMaxSizeInMB(long maxSize)
パラメーター:
- キューの最大サイズ (メガバイト単位)。 これは、キューに割り当てられたメモリのサイズです。
setRequiresDuplicateDetection
public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
パラメーター:
- True の 場合は、重複検出を有効にする必要があります。 参照 - isRequiresDuplicateDetection()
setRequiresSession
public void setRequiresSession(boolean requiresSession)
パラメーター:
- キューでセッションをサポートする必要がある場合は True です。
setUserMetadata
public void setUserMetadata(String userMetadata)
パラメーター:
- ユーザーが説明に関連付けることができるカスタム metdata。 null にすることはできません。 最大長は 1024 文字です
適用対象
Azure SDK for Java