CreateTopicOptions クラス

パッケージ:

com.azure.messaging.servicebus.administration.models

Maven 成果物:

com.azure:azure-messaging-servicebus:7.15.1

• java.lang.Object
• • com.azure.messaging.servicebus.administration.models.CreateTopicOptions

public final class CreateTopicOptions

トピックの作成に指定できるオプションのセットを表します。

コンストラクターの概要

コンストラクター	説明
CreateTopicOptions()	インスタンスを作成します。
CreateTopicOptions(TopicProperties topic)	指定した CreateTopicOptions インスタンスに基づいて新しいインスタンスを初期化します。

メソッドの概要

修飾子と型	メソッドと説明
List<AuthorizationRule>	getAuthorizationRules() エンティティ レベルでユーザー アクセスを制御する承認規則を取得します。
Duration	getAutoDeleteOnIdle() 自動削除OnIdle プロパティを取得します。ISO 8601 timeSpan アイドル間隔後、キューは自動的に削除されます。
Duration	getDefaultMessageTimeToLive() 既定の MessageTimeToLive プロパティを取得します。ISO 8601 の既定のメッセージ時間スパンがライブ値になります。
Duration	getDuplicateDetectionHistoryTimeWindow() 重複検出履歴の時間枠プロパティを取得します。重複検出履歴の期間を定義する ISO 8601 タイムスパン構造。
Duration	getLockDuration() lockDuration プロパティを取得します。 ISO 8601 timespan duration of a peek-lock, つまり、メッセージが他の受信者に対してロックされている時間です。
int	getMaxDeliveryCount() [最大配信数] プロパティを取得します。最大配信数。
long	getMaxMessageSizeInKilobytes() 最大メッセージサイズInKilobytes プロパティを取得します。メッセージの最大サイズ (キロバイト単位)。
long	getMaxSizeInMegabytes() 最大サイズInMegabytes プロパティを取得します。キューの最大サイズ (MB 単位) です。これは、キューに割り当てられたメモリのサイズです。
EntityStatus	getStatus() status プロパティを取得します。Service Bus リソースの状態。
String	getUserMetadata() ユーザーメタデータプロパティを取得する: ユーザーが説明に関連付けることができるカスタム metdata。
Boolean	isBatchedOperationsEnabled() [バッチ処理操作の有効化] プロパティを取得します。サーバー側のバッチ処理操作が有効かどうかを示す値です。
Boolean	isDuplicateDetectionRequired() [requires Duplicate Detection]\(重複検出が必要\) プロパティを取得します。このキューで重複検出が必要かどうかを示す値。
Boolean	isPartitioningEnabled() [パーティション分割の有効化] プロパティを取得します。キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。
Boolean	isSessionRequired() requiresSession プロパティを取得します。キューがセッションの概念をサポートしているかどうかを示す値です。
boolean	isSupportOrdering() 順序を維持する必要があるかどうかを定義します。
CreateTopicOptions	setAutoDeleteOnIdle(Duration autoDeleteOnIdle) AutoDelete OnIdle プロパティを設定します。 ISO 8601 timeSpan idle interval after the queue is automatically deleted.
CreateTopicOptions	setBatchedOperationsEnabled(boolean enableBatchedOperations) [バッチ処理操作の有効化] プロパティを設定します。サーバー側のバッチ処理操作が有効かどうかを示す値です。
CreateTopicOptions	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive) 既定の MessageTimeToLive プロパティを設定します。ISO 8601 の既定のメッセージ期間をライブ値に設定します。
CreateTopicOptions	setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow) [重複検出履歴の時間枠] プロパティを設定します。重複検出履歴の期間を定義する ISO 8601 タイムスパン構造。
CreateTopicOptions	setDuplicateDetectionRequired(boolean requiresDuplicateDetection) [requires Duplicate Detection]\(重複検出が必要\) プロパティを設定します。このキューで重複検出が必要かどうかを示す値。
CreateTopicOptions	setLockDuration(Duration lockDuration) lockDuration プロパティを設定します。 ISO 8601 timespan duration of a peek-lock, つまり、メッセージが他の受信者に対してロックされている時間です。
CreateTopicOptions	setMaxDeliveryCount(int maxDeliveryCount) [最大配信数] プロパティを設定します。最大配信数。
CreateTopicOptions	setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes) 最大メッセージサイズInKilobytes プロパティを設定する: Premium レベルでのみ使用できる既定の最大メッセージ サイズ (キロバイト単位) オプションを表します。
CreateTopicOptions	setMaxSizeInMegabytes(long maxSizeInMegabytes) 最大サイズInMegabytes プロパティを設定します。キューの最大サイズ (MB 単位) は、キューに割り当てられたメモリのサイズです。
CreateTopicOptions	setOrderingSupported(boolean supportOrdering) 順序を維持する必要があるかどうかを定義します。
CreateTopicOptions	setPartitioningEnabled(boolean enablePartitioning) [パーティション分割の有効化] プロパティを設定します。キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値です。
CreateTopicOptions	setSessionRequired(boolean requiresSession) requiresSession プロパティを設定します。キューがセッションの概念をサポートしているかどうかを示す値です。
CreateTopicOptions	setStatus(EntityStatus status) status プロパティを設定します。Service Bus リソースの状態。
CreateTopicOptions	setUserMetadata(String userMetadata) ユーザーメタデータ プロパティを設定します。ユーザーが説明に関連付けることができるカスタム metdata。

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

CreateTopicOptions

public CreateTopicOptions()

インスタンスを作成します。 トピックの既定値が設定されます。 既定値が設定されたプロパティは次のとおりです。

• setAutoDeleteOnIdle(Duration autoDeleteOnIdle) は最大期間の値です。
• setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive) は最大期間の値です。
• setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow) は最大期間の値ですが、重複検出は無効です。
• setDuplicateDetectionRequired(boolean requiresDuplicateDetection) が false です。
• setBatchedOperationsEnabled(boolean enableBatchedOperations) (boolean)}は true です。
• setLockDuration(Duration lockDuration) は 1 分です。
• setMaxDeliveryCount(int maxDeliveryCount) は 10 です。
• setMaxSizeInMegabytes(long maxSizeInMegabytes) は 1024 MB です。
• setSessionRequired(boolean requiresSession) が false です。
• setStatus(EntityStatus status) は ACTIVE です。

CreateTopicOptions

public CreateTopicOptions(TopicProperties topic)

指定した CreateTopicOptions インスタンスに基づいて新しいインスタンスを初期化します。 これは、既存の topicOptions のプロパティに基づいて新しいトピックを作成する場合に便利です。

Parameters:

topic - 既存のトピックオプションを使用してオプションを作成するオプション。

メソッドの詳細

getAuthorizationRules

public List getAuthorizationRules()

エンティティ レベルでユーザー アクセスを制御する承認規則を取得します。

Returns:

エンティティ レベルでユーザー アクセスを制御するための承認規則。

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

autoDeleteOnIdle プロパティを取得します。ISO 8601 timeSpan アイドル間隔後、キューが自動的に削除されます。 最小時間は、5 分です。

Returns:

autoDeleteOnIdle 値。

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

defaultMessageTimeToLive プロパティを取得します。ISO 8601 の既定のメッセージ時間スパンがライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。

Returns:

defaultMessageTimeToLive 値。

getDuplicateDetectionHistoryTimeWindow

public Duration getDuplicateDetectionHistoryTimeWindow()

duplicateDetectionHistoryTimeWindow プロパティを取得します。重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。

Returns:

duplicateDetectionHistoryTimeWindow 値。

getLockDuration

public Duration getLockDuration()

lockDuration プロパティを取得します。ピーク ロックの期間は ISO 8601 です。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。

Returns:

lockDuration 値。

getMaxDeliveryCount

public int getMaxDeliveryCount()

maxDeliveryCount プロパティを取得します。最大配信数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。

Returns:

maxDeliveryCount 値。

getMaxMessageSizeInKilobytes

public long getMaxMessageSizeInKilobytes()

maxMessageSizeInKilobytes プロパティを取得します。メッセージの最大サイズ (キロバイト単位)。

Returns:

maxMessageSizeInKilobytes 値。

getMaxSizeInMegabytes

public long getMaxSizeInMegabytes()

maxSizeInMegabytes プロパティを取得します。キューの最大サイズ (MB 単位) は、キューに割り当てられたメモリのサイズです。

Returns:

maxSizeInMegabytes 値。

getStatus

public EntityStatus getStatus()

status プロパティを取得します。Service Bus リソースの状態。

Returns:

状態の値。

getUserMetadata

public String getUserMetadata()

userMetadata プロパティを取得する: ユーザーが説明に関連付けることができるカスタム metdata。 最大長は 1024 文字です。

Returns:

userMetadata 値。

isBatchedOperationsEnabled

public Boolean isBatchedOperationsEnabled()

enableBatchedOperations プロパティを取得します。サーバー側のバッチ処理操作が有効かどうかを示す値です。

Returns:

enableBatchedOperations 値。

isDuplicateDetectionRequired

public Boolean isDuplicateDetectionRequired()

requiresDuplicateDetection プロパティを取得します。このキューで重複検出が必要かどうかを示す値。

Returns:

requiresDuplicateDetection 値。

isPartitioningEnabled

public Boolean isPartitioningEnabled()

enablePartitioning プロパティを取得します。キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値です。

Returns:

enablePartitioning 値。

isSessionRequired

public Boolean isSessionRequired()

requiresSession プロパティを取得します。キューがセッションの概念をサポートしているかどうかを示す値です。

Returns:

にはSession 値が必要です。

isSupportOrdering

public boolean isSupportOrdering()

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

Returns:

順序を維持する必要がある場合は true。それ以外の場合は false。

setAutoDeleteOnIdle

public CreateTopicOptions setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

autoDeleteOnIdle プロパティを設定します。ISO 8601 timeSpan アイドル間隔後、キューが自動的に削除されます。 最小時間は、5 分です。

Parameters:

autoDeleteOnIdle - 設定する autoDeleteOnIdle 値。

Returns:

CreateTopicOptions オブジェクト自体。

setBatchedOperationsEnabled

public CreateTopicOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)

enableBatchedOperations プロパティを設定します。サーバー側のバッチ処理操作が有効かどうかを示す値です。

Parameters:

enableBatchedOperations - 設定する enableBatchedOperations 値。

Returns:

CreateTopicOptions オブジェクト自体。

setDefaultMessageTimeToLive

public CreateTopicOptions setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

defaultMessageTimeToLive プロパティを設定します。ISO 8601 の既定のメッセージ期間をライブ値に設定します。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。

Parameters:

defaultMessageTimeToLive - 設定する defaultMessageTimeToLive 値。

Returns:

CreateTopicOptions オブジェクト自体。

setDuplicateDetectionHistoryTimeWindow

public CreateTopicOptions setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

duplicateDetectionHistoryTimeWindow プロパティを設定します。重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。

Parameters:

duplicateDetectionHistoryTimeWindow - 設定する duplicateDetectionHistoryTimeWindow 値。

Returns:

CreateTopicOptions オブジェクト自体。

setDuplicateDetectionRequired

public CreateTopicOptions setDuplicateDetectionRequired(boolean requiresDuplicateDetection)

requiresDuplicateDetection プロパティを設定します。このキューで重複検出が必要かどうかを示す値。

Parameters:

requiresDuplicateDetection - 設定する requiresDuplicateDetection 値。

Returns:

CreateTopicOptions オブジェクト自体。

setLockDuration

public CreateTopicOptions setLockDuration(Duration lockDuration)

lockDuration プロパティを設定します。ピーク ロックの期間は ISO 8601 です。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。

Parameters:

lockDuration - 設定する lockDuration 値。

Returns:

CreateTopicOptions オブジェクト自体。

setMaxDeliveryCount

public CreateTopicOptions setMaxDeliveryCount(int maxDeliveryCount)

maxDeliveryCount プロパティを設定します。最大配信数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。

Parameters:

maxDeliveryCount - 設定する maxDeliveryCount 値。

Returns:

CreateTopicOptions オブジェクト自体。

setMaxMessageSizeInKilobytes

public CreateTopicOptions setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes)

maxMessageSizeInKilobytes プロパティを設定する: Premium レベルでのみ使用できる既定の最大メッセージ サイズ (キロバイト単位) オプションを表します。 Standard レベルの既定の最大値は 256 KB、Premium レベルでは 1 MB です。 プレビューでは、より大きなメッセージ サイズを使用できます。 詳細については、こちらをご覧ください

Parameters:

maxMessageSizeInKilobytes - 設定する maxMessageSizeInKilobytes 値。

Returns:

CreateTopicOptions オブジェクト自体。

setMaxSizeInMegabytes

public CreateTopicOptions setMaxSizeInMegabytes(long maxSizeInMegabytes)

maxSizeInMegabytes プロパティを設定します。キューの最大サイズ (MB 単位) は、キューに割り当てられたメモリのサイズです。

Parameters:

maxSizeInMegabytes - 設定する maxSizeInMegabytes 値。

Returns:

CreateTopicOptions オブジェクト自体。

setOrderingSupported

public CreateTopicOptions setOrderingSupported(boolean supportOrdering)

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

Parameters:

supportOrdering - 順序を維持する必要がある場合は true。それ以外の場合は false。

Returns:

CreateTopicOptions オブジェクト自体。

setPartitioningEnabled

public CreateTopicOptions setPartitioningEnabled(boolean enablePartitioning)

enablePartitioning プロパティを設定します。キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値です。

Parameters:

enablePartitioning - 設定する enablePartitioning 値。

Returns:

CreateTopicOptions オブジェクト自体。

setSessionRequired

public CreateTopicOptions setSessionRequired(boolean requiresSession)

requiresSession プロパティを設定します。キューがセッションの概念をサポートしているかどうかを示す値です。

Parameters:

requiresSession - を設定するには、Session 値が必要です。

Returns:

CreateTopicOptions オブジェクト自体。

setStatus

public CreateTopicOptions setStatus(EntityStatus status)

status プロパティを設定します。Service Bus リソースの状態。

Parameters:

status - 設定する状態値。

Returns:

CreateTopicOptions オブジェクト自体。

setUserMetadata

public CreateTopicOptions setUserMetadata(String userMetadata)

userMetadata プロパティを設定します。ユーザーが説明に関連付けることができるカスタム metdata。 最大長は 1024 文字です。

Parameters:

userMetadata - 設定する userMetadata 値。

Returns:

CreateTopicOptions オブジェクト自体。