TopicDescription クラス

パッケージ:

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.TopicDescription

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

トピックのメタデータの説明を表します。

コンストラクターの概要

コンストラクター	説明
TopicDescription(String path)	指定した相対パスを使用して、トピックの説明の新しいインスタンスを初期化します。

メソッドの概要

修飾子と型	メソッドと説明
boolean	equals(Object o)
List<AuthorizationRule>	getAuthorizationRules()
Duration	getAutoDeleteOnIdle()
Duration	getDefaultMessageTimeToLive() Time-To-Live は、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。
Duration	getDuplicationDetectionHistoryTimeWindow()
EntityStatus	getEntityStatus() エンティティの状態を取得します。
long	getMaxSizeInMB()
String	getPath()
String	getUserMetadata()
int	hashCode()
boolean	isEnableBatchedOperations()
boolean	isEnablePartitioning()
boolean	isRequiresDuplicateDetection() 有効にすると、同じ getMessageId() メッセージを持ち、 の #getDuplicationDetectionHistoryTimeWindow 期間内にキューに送信された重複するメッセージは破棄されます。
boolean	isSupportOrdering()
void	setAuthorizationRules(List<AuthorizationRule> authorizationRules)
void	setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void	setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
void	setEnableBatchedOperations(boolean enableBatchedOperations)
void	setEnablePartitioning(boolean enablePartitioning)
void	setEntityStatus(EntityStatus status)
void	setMaxSizeInMB(long maxSize)
void	setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
void	setSupportOrdering(boolean supportOrdering)
void	setUserMetadata(String userMetadata)

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

TopicDescription

public TopicDescription(String path)

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

パラメーター:

path -

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

メソッドの詳細

equals

public boolean equals(Object o)

上書き:

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

getMaxSizeInMB

public long getMaxSizeInMB()

戻り値:

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

getPath

public String getPath()

戻り値:

トピックのパス。

getUserMetadata

public String getUserMetadata()

戻り値:

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

hashCode

public int hashCode()

上書き:

TopicDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

戻り値:

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

isEnablePartitioning

public boolean isEnablePartitioning()

戻り値:

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

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

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

戻り値:

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

isSupportOrdering

public boolean isSupportOrdering()

戻り値:

順序を維持する必要があるかどうかを定義します。 true の場合、トピックに送信されたメッセージは順番にサブスクリプションに転送されます。 既定値は false

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 -

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

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

パラメーター:

enablePartitioning -

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

setEntityStatus

public void setEntityStatus(EntityStatus status)

パラメーター:

status -

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

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

パラメーター:

maxSize -

• トピックの最大サイズをメガバイト単位で設定します。これは、トピックに割り当てられたメモリのサイズです。

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

パラメーター:

requiresDuplicateDetection -

• 重複検出を有効にする必要がある場合は、true に設定します。 関連項目 - isRequiresDuplicateDetection()

setSupportOrdering

public void setSupportOrdering(boolean supportOrdering)

パラメーター:

supportOrdering -

• 順序を維持する必要があるかどうかを定義します。 true の場合、トピックに送信されたメッセージは順番にサブスクリプションに転送されます。

setUserMetadata

public void setUserMetadata(String userMetadata)

パラメーター:

userMetadata -

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