SubscriptionProperties クラス

パッケージ:

com.azure.messaging.servicebus.administration.models

Maven 成果物:

com.azure:azure-messaging-servicebus:7.15.1

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

public final class SubscriptionProperties

サブスクリプションのプロパティ。

メソッドの概要

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

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

メソッドの詳細

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

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

Returns:

autoDeleteOnIdle 値。

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

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

Returns:

defaultMessageTimeToLive 値。

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:

状態の値。

getSubscriptionName

public String getSubscriptionName()

サブスクリプションの名前を取得します。

Returns:

サブスクリプションの名前です。

getTopicName

public String getTopicName()

サブスクリプションが存在するトピックの名前を取得します。

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 SubscriptionProperties setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

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

Parameters:

autoDeleteOnIdle - 設定する autoDeleteOnIdle 値。

Returns:

SubscriptionProperties オブジェクト自体。

setBatchedOperationsEnabled

public SubscriptionProperties setBatchedOperationsEnabled(boolean enableBatchedOperations)

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

Parameters:

enableBatchedOperations - 設定する enableBatchedOperations 値。

Returns:

SubscriptionProperties オブジェクト自体。

setDeadLetteringOnMessageExpiration

public SubscriptionProperties setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)

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

Parameters:

deadLetteringOnMessageExpiration - 設定する deadLetteringOnMessageExpiration 値。

Returns:

SubscriptionProperties オブジェクト自体。

setDefaultMessageTimeToLive

public SubscriptionProperties setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

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

Parameters:

defaultMessageTimeToLive - 設定する defaultMessageTimeToLive 値。

Returns:

SubscriptionProperties オブジェクト自体。

setEnableDeadLetteringOnFilterEvaluationExceptions

public SubscriptionProperties setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions)

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

Parameters:

deadLetteringOnFilterEvaluationExceptions - 設定する deadLetteringOnFilterEvaluationExceptions 値。

Returns:

SubscriptionProperties オブジェクト自体。

setForwardDeadLetteredMessagesTo

public SubscriptionProperties setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

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

Parameters:

forwardDeadLetteredMessagesTo - 設定する forwardDeadLetteredMessagesTo 値。

Returns:

SubscriptionProperties オブジェクト自体。

setForwardTo

public SubscriptionProperties setForwardTo(String forwardTo)

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

Parameters:

forwardTo - 設定する forwardTo 値。

Returns:

SubscriptionProperties オブジェクト自体。

setLockDuration

public SubscriptionProperties setLockDuration(Duration lockDuration)

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

Parameters:

lockDuration - 設定する lockDuration 値。

Returns:

SubscriptionProperties オブジェクト自体。

setMaxDeliveryCount

public SubscriptionProperties setMaxDeliveryCount(int maxDeliveryCount)

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

Parameters:

maxDeliveryCount - 設定する maxDeliveryCount 値。

Returns:

SubscriptionProperties オブジェクト自体。

setStatus

public SubscriptionProperties setStatus(EntityStatus status)

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

Parameters:

status - 設定する状態値。

Returns:

SubscriptionProperties オブジェクト自体。

setUserMetadata

public SubscriptionProperties setUserMetadata(String userMetadata)

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

Parameters:

userMetadata - 設定する userMetadata 値。

Returns:

SubscriptionProperties オブジェクト自体。