你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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() 获取自动删除OnIdle 属性：ISO 8601 时间跨度空闲间隔，在此间隔后，订阅将自动删除。
Duration	getDefaultMessageTimeToLive() 获取默认的 MessageTimeToLive 属性：ISO 8601 默认消息时间跨度到实时值。
RuleProperties	getDefaultRule() 获取创建订阅时所使用的规则（如果有）。
String	getForwardDeadLetteredMessagesTo() 获取转发死信邮件收件人属性：发送到订阅的所有邮件都转发到的收件人实体的名称。
String	getForwardTo() 获取 forwardTo 属性：发送到订阅的所有消息都转发到的收件人实体的名称。
Duration	getLockDuration() 获取 lockDuration 属性：ISO 8601 速览锁的时间跨度持续时间;即消息锁定给其他接收方的时间量。
int	getMaxDeliveryCount() 获取“最大传递计数”属性：最大传递计数。
EntityStatus	getStatus() 获取状态属性：服务总线资源的状态。
String	getUserMetadata() 获取用户元数据属性：与订阅关联的元数据。
boolean	isBatchedOperationsEnabled() 获取 enableBatchedOperations 属性：指示是否启用服务器端批处理操作的值。
boolean	isDeadLetteringOnFilterEvaluationExceptions() 获取死信OnFilter评估异常属性：指示消息过期时此订阅是否具有死信支持的值。
boolean	isDeadLetteringOnMessageExpiration() 获取死信OnMessageExpiration 属性：指示消息过期时此订阅是否具有死信支持的值。
boolean	isSessionRequired() 获取 requiresSession 属性：一个指示队列是否支持会话概念的值。
CreateSubscriptionOptions	setAutoDeleteOnIdle(Duration autoDeleteOnIdle) 设置自动删除OnIdle 属性：ISO 8601 时间跨度空闲间隔，在此间隔后自动删除订阅。
CreateSubscriptionOptions	setBatchedOperationsEnabled(boolean enableBatchedOperations) 设置 enableBatchedOperations 属性：指示是否启用服务器端批处理操作的值。
CreateSubscriptionOptions	setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration) 设置死信OnMessageExpiration 属性：指示消息过期时此订阅是否具有死信支持的值。
CreateSubscriptionOptions	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive) 将默认消息时间ToLive 属性：ISO 8601 默认消息时间跨度设置为实时值。
CreateSubscriptionOptions	setDefaultRule(RuleProperties ruleProperties) 设置应用于创建订阅的规则（如果有）。
CreateSubscriptionOptions	setEnableDeadLetteringOnFilterEvaluationExceptions(boolean deadLetteringOnFilterEvaluationExceptions) 设置死信OnFilter评估异常属性：指示消息过期时此订阅是否具有死信支持的值。
CreateSubscriptionOptions	setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo) 将转发死信消息设置为 属性：发送到订阅的所有消息都转发到的收件人实体的名称。
CreateSubscriptionOptions	setForwardTo(String forwardTo) 设置 forwardTo 属性：发送到订阅的所有消息都转发到的收件人实体的名称。
CreateSubscriptionOptions	setLockDuration(Duration lockDuration) 设置 lockDuration 属性：ISO 8601 速览锁的时间跨度持续时间;即其他接收方锁定消息的时间量。
CreateSubscriptionOptions	setMaxDeliveryCount(int maxDeliveryCount) 设置“最大传递计数”属性：最大传递计数。
CreateSubscriptionOptions	setSessionRequired(boolean requiresSession) 设置“需要会话”属性：一个指示队列是否支持会话概念的值。
CreateSubscriptionOptions	setStatus(EntityStatus status) 设置状态属性：服务总线资源的状态。
CreateSubscriptionOptions	setUserMetadata(String userMetadata) 设置用户元数据属性：与订阅关联的元数据。

方法继承自 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 默认消息时间跨度到实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 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()

获取状态属性：服务总线资源的状态。

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:

需要sSession 值。

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 默认消息时间跨度设置为实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 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 - 需要设置sSession 值。

Returns:

CreateSubscriptionOptions 对象本身。

setStatus

public CreateSubscriptionOptions setStatus(EntityStatus status)

设置状态属性：服务总线资源的状态。

Parameters:

status - 要设置的状态值。

Returns:

CreateSubscriptionOptions 对象本身。

setUserMetadata

public CreateSubscriptionOptions setUserMetadata(String userMetadata)

设置 userMetadata 属性：与订阅关联的元数据。 最多包含 1024 个字符。

Parameters:

userMetadata - 要设置的 userMetadata 值。

Returns:

CreateSubscriptionOptions 对象本身。