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

SubscriptionDescription 类

包:

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

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

表示订阅的元数据说明。

构造函数摘要

构造函数	说明
SubscriptionDescription(String topicPath, String subscriptionName)	使用指定的相对路径初始化订阅说明的新实例。

方法摘要

修饰符和类型	方法和描述
boolean	equals(Object o)
Duration	getAutoDeleteOnIdle()
Duration	getDefaultMessageTimeToLive() 生存时间是消息过期的持续时间，从消息发送到服务总线时开始。
EntityStatus	getEntityStatus() 获取实体的状态。
String	getForwardDeadLetteredMessagesTo()
String	getForwardTo()
Duration	getLockDuration() 给定接收方锁定消息的时间量，使其他接收方无法接收同一消息。
int	getMaxDeliveryCount() 消息在死信之前的最大传递计数。
String	getPath()
String	getSubscriptionName()
String	getTopicPath()
String	getUserMetadata()
int	hashCode()
boolean	isEnableBatchedOperations()
boolean	isEnableDeadLetteringOnFilterEvaluationException()
boolean	isEnableDeadLetteringOnMessageExpiration() 指示消息过期时此订阅是否支持死信。
boolean	isRequiresSession()
void	setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void	setEnableBatchedOperations(boolean enableBatchedOperations)
void	setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)
void	setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
void	setEntityStatus(EntityStatus status)
void	setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
void	setForwardTo(String forwardTo)
void	setLockDuration(Duration lockDuration) 设置给定接收方锁定消息的时间量，以便其他接收方不会接收同一消息。
void	setMaxDeliveryCount(int maxDeliveryCount) 消息在死信之前的最大传递计数。
void	setRequiresSession(boolean requiresSession)
void	setUserMetadata(String userMetadata)

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

构造函数详细信息

SubscriptionDescription

public SubscriptionDescription(String topicPath, String subscriptionName)

使用指定的相对路径初始化 SubscriptionDescription 的新实例。

参数:

topicPath -

• 主题的路径最大长度为 260 个字符。 不能以斜杠开头或结尾。 不能有受限字符：“@”，'？'，'#'，'*'

subscriptionName -

• 订阅的名称最大长度为 50 个字符。 不能有受限字符：“@”，'？'，'#'，'*'，'/'

方法详细信息

equals

public boolean equals(Object o)

替代:

SubscriptionDescription.equals(Object o)

参数:

o

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

返回:

自动删除订阅的空闲间隔。 默认值为 MAX_DURATION

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

生存时间是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 时 getTimeToLive() 使用的默认值。 超过 TimeToLive 值的消息将会到期，不再保留在消息存储中。 订户无法检索已到期的消息。

返回:

消息的默认生存时间值。 默认值为 MAX_DURATION

getEntityStatus

public EntityStatus getEntityStatus()

获取实体的状态。 禁用实体时，该实体无法发送或接收消息。

返回:

队列的当前状态 (已启用/禁用) 。 默认值为“已启用”。

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

返回:

此订阅的所有死信邮件都转发到的收件人实体的路径。 如果设置，用户无法手动接收来自此订阅的死信消息。 目标实体必须已存在。

getForwardTo

public String getForwardTo()

返回:

发送到订阅的所有消息都转发到的收件人实体的路径。 如果设置，用户无法手动接收来自此订阅的消息。 目标实体必须是已存在的实体。

getLockDuration

public Duration getLockDuration()

给定接收方锁定消息的时间量，使其他接收方无法接收同一消息。

返回:

速览锁定的持续时间。 默认值为 60 秒。

getMaxDeliveryCount

public int getMaxDeliveryCount()

消息在死信之前的最大传递计数。 当在模式下收到消息且未在 PEEKLOCK 消息锁定过期之前完成消息时，传递计数会增加。

返回:

默认值为 10。

getPath

public String getPath()

返回:

订阅的路径，包括 主题。

getSubscriptionName

public String getSubscriptionName()

返回:

订阅名称。

getTopicPath

public String getTopicPath()

返回:

主题的路径。

getUserMetadata

public String getUserMetadata()

返回:

用户可以与说明关联的自定义 metdata。

hashCode

public int hashCode()

替代:

SubscriptionDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

返回:

指示是否启用服务器端批处理操作。 默认为 true。

isEnableDeadLetteringOnFilterEvaluationException

public boolean isEnableDeadLetteringOnFilterEvaluationException()

返回:

指示当订阅规则评估失败时，消息是否需要转发到死信子队列的布尔值。 默认值为 true。

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

指示消息过期时此订阅是否支持死信。

返回:

如果为 true，则过期的消息将移动到死信子队列。 默认值为 false。

isRequiresSession

public boolean isRequiresSession()

返回:

这指示订阅是否支持会话的概念。 会话消息遵循 FIFO 排序。

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

参数:

autoDeleteOnIdle -

• 自动删除订阅的空闲间隔。 最短持续时间为 5 分钟。

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

参数:

defaultMessageTimeToLive -

• 设置默认消息生存时间值。 值不能小于 1 秒。 请参见getDefaultMessageTimeToLive()

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

参数:

enableBatchedOperations -

• 指示是否启用服务器端批处理操作。

setEnableDeadLetteringOnFilterEvaluationException

public void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)

参数:

enableDeadLetteringOnFilterEvaluationException -

• 如果消息在筛选器评估异常中应为死信，则其值为 True。 请参见isEnableDeadLetteringOnFilterEvaluationException()

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

参数:

enableDeadLetteringOnMessageExpiration -

• 如此 如果消息应在过期时死信。 请参见isEnableDeadLetteringOnMessageExpiration()

setEntityStatus

public void setEntityStatus(EntityStatus status)

参数:

status -

• 队列的状态 (已启用/禁用) 。 禁用实体时，该实体无法发送或接收消息。

setForwardDeadLetteredMessagesTo

public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

参数:

forwardDeadLetteredMessagesTo -

• 此订阅的所有死信邮件都转发到的收件人实体的路径。 如果设置，用户无法手动接收来自此订阅的死信消息。 目标实体必须已存在。

setForwardTo

public void setForwardTo(String forwardTo)

参数:

forwardTo -

• 发送到订阅的所有消息都转发到的收件人实体的路径。 如果设置，用户无法手动接收来自此订阅的消息。 目标实体必须是已存在的实体。

setLockDuration

public void setLockDuration(Duration lockDuration)

设置给定接收方锁定消息的时间量，以便其他接收方不会接收同一消息。

参数:

lockDuration -

• 速览锁定的持续时间。 最大值为 5 分钟。

setMaxDeliveryCount

public void setMaxDeliveryCount(int maxDeliveryCount)

消息在死信之前的最大传递计数。 当在模式下收到消息且未在 PEEKLOCK 消息锁定过期之前完成消息时，传递计数会增加。

参数:

maxDeliveryCount -

• 最小值为 1。

setRequiresSession

public void setRequiresSession(boolean requiresSession)

参数:

requiresSession -

• 如果订阅应支持会话，则设置为 true。

setUserMetadata

public void setUserMetadata(String userMetadata)

参数:

userMetadata -

• 用户可以与说明关联的自定义 metdata。 不能为 null。 最大长度为 1024 个字符