CreateSubscriptionOptions クラス

リファレンス

パッケージ:: com.azure.messaging.servicebus.administration.models

Maven 成果物:: com.azure:azure-messaging-servicebus:7.15.1

java.lang.Object
- com.azure.messaging.servicebus.administration.models.CreateSubscriptionOptions

public final class CreateSubscriptionOptions

サブスクリプションの作成時に設定するオプション。

コンストラクターの概要

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

メソッドの概要

修飾子と型	メソッドと説明
Duration	getAutoDeleteOnIdle() AutoDelete OnIdle プロパティを取得します。 ISO 8601 timeSpan idle interval after the subscription is automatically deleted.
Duration	getDefaultMessageTimeToLive() 既定の MessageTimeToLive プロパティを取得します。ISO 8601 の既定のメッセージの期間はライブ値になります。
RuleProperties	getDefaultRule() サブスクリプションが作成されたルール (存在する場合) を取得します。
String	getForwardDeadLetteredMessagesTo() [配信不能メッセージの転送先] プロパティを取得します。サブスクリプションに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。
String	getForwardTo() forwardTo プロパティの取得: サブスクリプションに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。
Duration	getLockDuration() ロックDuration プロパティを取得します。ピークロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。
int	getMaxDeliveryCount() [最大配信数] プロパティを取得します。最大配信数。
EntityStatus	getStatus() status プロパティを取得します。Service Bus リソースの状態。
String	getUserMetadata() ユーザーの Metadata プロパティを取得します。サブスクリプションに関連付けられているメタデータ。
boolean	isBatchedOperationsEnabled() [バッチ処理操作の有効化] プロパティを取得します。サーバー側のバッチ処理操作が有効かどうかを示す値です。
boolean	isDeadLetteringOnFilterEvaluationExceptions() 配信不能OnFilter評価例外プロパティの取得: メッセージの有効期限が切れたときに、このサブスクリプションが配信不能サポートを持っているかどうかを示す値。
boolean	isDeadLetteringOnMessageExpiration() 配信不能OnMessageExpiration プロパティを取得する: メッセージの有効期限が切れたときに、このサブスクリプションが配信不能サポートを持っているかどうかを示す値。
boolean	isSessionRequired() requiresSession プロパティを取得します。キューがセッションの概念をサポートしているかどうかを示す値です。
CreateSubscriptionOptions	setAutoDeleteOnIdle(Duration autoDeleteOnIdle) 自動削除OnIdle プロパティを設定します。ISO 8601 期間のアイドル間隔後、サブスクリプションは自動的に削除されます。
CreateSubscriptionOptions	setBatchedOperationsEnabled(boolean enableBatchedOperations) [バッチ処理操作の有効化] プロパティを設定します。サーバー側のバッチ処理操作が有効かどうかを示す値です。
CreateSubscriptionOptions	setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration) 配信不能OnMessageExpiration プロパティを設定する: メッセージの有効期限が切れたときに、このサブスクリプションが配信不能サポートを持っているかどうかを示す値。
CreateSubscriptionOptions	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive) 既定の MessageTimeToLive プロパティを設定します。ISO 8601 の既定のメッセージ期間をライブ値に設定します。
CreateSubscriptionOptions	setDefaultRule(RuleProperties ruleProperties) サブスクリプションを作成する規則 (存在する場合) を設定します。
CreateSubscriptionOptions	setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions) 配信不能OnFilter評価例外プロパティを設定する: メッセージの有効期限が切れたときに、このサブスクリプションが配信不能サポートを持っているかどうかを示す値。
CreateSubscriptionOptions	setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo) forwardDeadLetteredMessagesTo プロパティを設定します。サブスクリプションに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。
CreateSubscriptionOptions	setForwardTo(String forwardTo) forwardTo プロパティを設定する: サブスクリプションに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。
CreateSubscriptionOptions	setLockDuration(Duration lockDuration) lockDuration プロパティを設定します。 ISO 8601 ピークロックの期間。つまり、メッセージが他の受信者に対してロックされている時間です。
CreateSubscriptionOptions	setMaxDeliveryCount(int maxDeliveryCount) [最大配信数] プロパティを設定します。最大配信数。
CreateSubscriptionOptions	setSessionRequired(boolean requiresSession) requiresSession プロパティを設定します。キューがセッションの概念をサポートしているかどうかを示す値です。
CreateSubscriptionOptions	setStatus(EntityStatus status) status プロパティを設定します。Service Bus リソースの状態。
CreateSubscriptionOptions	setUserMetadata(String userMetadata) ユーザーの Metadata プロパティを設定します。サブスクリプションに関連付けられているメタデータ。

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

コンストラクターの詳細

CreateSubscriptionOptions

public CreateSubscriptionOptions()

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

setAutoDeleteOnIdle(Duration autoDeleteOnIdle) は最大継続時間の値です。
setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration) が false です。
setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive) は最大継続時間の値です。
setBatchedOperationsEnabled(boolean enableBatchedOperations) は true です。
setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions) は true です。
setLockDuration(Duration lockDuration) は 1 分です。
setMaxDeliveryCount(int maxDeliveryCount) は 10 です。
setSessionRequired(boolean requiresSession) が false です。
setStatus(EntityStatus status) は ACTIVE です。

CreateSubscriptionOptions

public CreateSubscriptionOptions(SubscriptionProperties subscription)

指定した SubscriptionProperties インスタンスに基づいて新しいインスタンスを初期化します。これは、既存のサブスクリプションのプロパティに基づいて新しいサブスクリプションを作成する場合に便利です。

Parameters:

subscription - オプションを作成する既存のサブスクリプション。

メソッドの詳細

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

autoDeleteOnIdle プロパティを取得します。ISO 8601 timeSpan アイドル間隔の後、サブスクリプションが自動的に削除されます。最小時間は、5 分です。

Returns:

autoDeleteOnIdle 値。

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

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

Returns:

defaultMessageTimeToLive 値。

getDefaultRule

public RuleProperties getDefaultRule()

サブスクリプションが作成されたルール (存在する場合) を取得します。

Returns:

ルールの説明

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

forwardDeadLetteredMessagesTo プロパティを取得します。サブスクリプションに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。

Returns:

forwardDeadLetteredMessagesTo 値。

getForwardTo

public String getForwardTo()

forwardTo プロパティの取得: サブスクリプションに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。

Returns:

forwardTo 値。

getLockDuration

public Duration getLockDuration()

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

Returns:

lockDuration 値。

getMaxDeliveryCount

public int getMaxDeliveryCount()

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

Returns:

maxDeliveryCount 値。

getStatus

public EntityStatus getStatus()

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

Returns:

状態の値。

getUserMetadata

public String getUserMetadata()

userMetadata プロパティを取得します。サブスクリプションに関連付けられているメタデータ。最大文字数は 1024 文字です。

Returns:

userMetadata 値。

isBatchedOperationsEnabled

public boolean isBatchedOperationsEnabled()

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

Returns:

enableBatchedOperations 値。

isDeadLetteringOnFilterEvaluationExceptions

public boolean isDeadLetteringOnFilterEvaluationExceptions()

deadLetteringOnFilterEvaluationExceptions プロパティを取得します。メッセージの有効期限が切れたときに、このサブスクリプションで配信不能がサポートされているかどうかを示す値です。

Returns:

deadLetteringOnFilterEvaluationExceptions 値。

isDeadLetteringOnMessageExpiration

public boolean isDeadLetteringOnMessageExpiration()

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

Returns:

deadLetteringOnMessageExpiration 値。

isSessionRequired

public boolean isSessionRequired()

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

Returns:

にはSession 値が必要です。

setAutoDeleteOnIdle

public CreateSubscriptionOptions setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

autoDeleteOnIdle プロパティを設定します。ISO 8601 timeSpan アイドル間隔後、サブスクリプションが自動的に削除されます。最小時間は、5 分です。

Parameters:

autoDeleteOnIdle - 設定する autoDeleteOnIdle 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setBatchedOperationsEnabled

public CreateSubscriptionOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)

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

Parameters:

enableBatchedOperations - 設定する enableBatchedOperations 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setDeadLetteringOnMessageExpiration

public CreateSubscriptionOptions setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)

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

Parameters:

deadLetteringOnMessageExpiration - 設定する deadLetteringOnMessageExpiration 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setDefaultMessageTimeToLive

public CreateSubscriptionOptions setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

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

Parameters:

defaultMessageTimeToLive - 設定する defaultMessageTimeToLive 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setDefaultRule

public CreateSubscriptionOptions setDefaultRule(RuleProperties ruleProperties)

サブスクリプションを作成する規則 (存在する場合) を設定します。

Parameters:

ruleProperties - ルールの説明 (名前、アクション、フィルター)

Returns:

CreateSubscriptionOptions オブジェクト自体。

setEnableDeadLetteringOnFilterEvaluationExceptions

public CreateSubscriptionOptions setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)

deadLetteringOnFilterEvaluationExceptions プロパティを設定します。メッセージの有効期限が切れたときに、このサブスクリプションで配信不能がサポートされているかどうかを示す値です。

Parameters:

deadLetteringOnFilterEvaluationExceptions - 設定する deadLetteringOnFilterEvaluationExceptions 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setForwardDeadLetteredMessagesTo

public CreateSubscriptionOptions setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

forwardDeadLetteredMessagesTo プロパティを設定します。サブスクリプションに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。

Parameters:

forwardDeadLetteredMessagesTo - 設定する forwardDeadLetteredMessagesTo 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setForwardTo

public CreateSubscriptionOptions setForwardTo(String forwardTo)

forwardTo プロパティを設定する: サブスクリプションに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。

Parameters:

forwardTo - 設定する forwardTo 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setLockDuration

public CreateSubscriptionOptions setLockDuration(Duration lockDuration)

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

Parameters:

lockDuration - 設定する lockDuration 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setMaxDeliveryCount

public CreateSubscriptionOptions setMaxDeliveryCount(int maxDeliveryCount)

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

Parameters:

maxDeliveryCount - 設定する maxDeliveryCount 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setSessionRequired

public CreateSubscriptionOptions setSessionRequired(boolean requiresSession)

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

Parameters:

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

Returns:

CreateSubscriptionOptions オブジェクト自体。

setStatus

public CreateSubscriptionOptions setStatus(EntityStatus status)

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

Parameters:

status - 設定する状態値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

setUserMetadata

public CreateSubscriptionOptions setUserMetadata(String userMetadata)

userMetadata プロパティを設定します。サブスクリプションに関連付けられているメタデータ。最大文字数は 1024 文字です。

Parameters:

userMetadata - 設定する userMetadata 値。

Returns:

CreateSubscriptionOptions オブジェクト自体。

次の方法で共有

CreateSubscriptionOptions クラス

コンストラクターの概要

メソッドの概要

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

コンストラクターの詳細

CreateSubscriptionOptions

CreateSubscriptionOptions

メソッドの詳細

getAutoDeleteOnIdle

getDefaultMessageTimeToLive

getDefaultRule

getForwardDeadLetteredMessagesTo

getForwardTo

getLockDuration

getMaxDeliveryCount

getStatus

getUserMetadata

isBatchedOperationsEnabled

isDeadLetteringOnFilterEvaluationExceptions

isDeadLetteringOnMessageExpiration

isSessionRequired

setAutoDeleteOnIdle

setBatchedOperationsEnabled

setDeadLetteringOnMessageExpiration

setDefaultMessageTimeToLive

setDefaultRule

setEnableDeadLetteringOnFilterEvaluationExceptions

setForwardDeadLetteredMessagesTo

setForwardTo

setLockDuration

setMaxDeliveryCount

setSessionRequired

setStatus

setUserMetadata

適用対象

その他のリソース