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

QueueDescription 类

包:

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

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

表示队列的元数据说明。

构造函数摘要

构造函数	说明
QueueDescription(String path)	使用指定的相对路径初始化队列说明的新实例。

方法摘要

修饰符和类型	方法和描述
boolean	equals(Object o)
List<AuthorizationRule>	getAuthorizationRules()
Duration	getAutoDeleteOnIdle()
Duration	getDefaultMessageTimeToLive() 生存时间是消息过期的持续时间，从消息发送到服务总线时开始。
Duration	getDuplicationDetectionHistoryTimeWindow()
EntityStatus	getEntityStatus() 获取实体的状态。
String	getForwardDeadLetteredMessagesTo()
String	getForwardTo()
Duration	getLockDuration() 给定接收方锁定消息的时间量，使其他接收方无法接收同一消息。
int	getMaxDeliveryCount() 消息在死信之前的最大传递计数。
long	getMaxSizeInMB()
String	getPath()
String	getUserMetadata()
int	hashCode()
boolean	isEnableBatchedOperations()
boolean	isEnableDeadLetteringOnMessageExpiration() 指示消息过期时此队列是否支持死信。
boolean	isEnablePartitioning()
boolean	isRequiresDuplicateDetection() 如果启用，将放弃在 的持续时间内具有相同 getMessageId() 并发送到队列的 #getDuplicationDetectionHistoryTimeWindow 重复消息。
boolean	isRequiresSession()
void	setAuthorizationRules(List<AuthorizationRule> authorizationRules)
void	setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void	setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
void	setEnableBatchedOperations(boolean enableBatchedOperations)
void	setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
void	setEnablePartitioning(boolean enablePartitioning)
void	setEntityStatus(EntityStatus status)
void	setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
void	setForwardTo(String forwardTo)
void	setLockDuration(Duration lockDuration) 设置给定接收方锁定消息的时间量，以便其他接收方不会接收同一消息。
void	setMaxDeliveryCount(int maxDeliveryCount) 消息在死信之前的最大传递计数。
void	setMaxSizeInMB(long maxSize)
void	setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
void	setRequiresSession(boolean requiresSession)
void	setUserMetadata(String userMetadata)

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

构造函数详细信息

QueueDescription

public QueueDescription(String path)

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

参数:

path -

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

方法详细信息

equals

public boolean equals(Object o)

替代:

QueueDescription.equals(Object o)

参数:

o

getAuthorizationRules

public List getAuthorizationRules()

返回:

AuthorizationRule用于在实体级别控制用户访问的队列上的 。

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

返回:

自动删除队列的空闲间隔。 默认值为 MAX_DURATION

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

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

返回:

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

getDuplicationDetectionHistoryTimeWindow

public Duration getDuplicationDetectionHistoryTimeWindow()

返回:

服务维护的重复检测历史记录的持续时间。 默认值为 1 分钟。

getEntityStatus

public EntityStatus getEntityStatus()

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

返回:

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

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

返回:

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

getForwardTo

public String getForwardTo()

返回:

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

getLockDuration

public Duration getLockDuration()

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

返回:

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

getMaxDeliveryCount

public int getMaxDeliveryCount()

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

返回:

默认值为 10。

getMaxSizeInMB

public long getMaxSizeInMB()

返回:

队列的最大大小（以 MB 为单位），即为队列分配的内存大小。 默认值为 1024。

getPath

public String getPath()

返回:

队列的路径。

getUserMetadata

public String getUserMetadata()

返回:

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

hashCode

public int hashCode()

替代:

QueueDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

返回:

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

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

指示消息过期时此队列是否支持死信。

返回:

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

isEnablePartitioning

public boolean isEnablePartitioning()

返回:

指示队列是否要跨多个消息中转站进行分区的布尔值。 默认为 false

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

如果启用，将放弃在 的持续时间内具有相同 getMessageId() 并发送到队列的 #getDuplicationDetectionHistoryTimeWindow 重复消息。

返回:

指示队列是否需要防范重复消息的值。

isRequiresSession

public boolean isRequiresSession()

返回:

指示队列是否支持会话概念的布尔值。 会话消息遵循 FIFO 排序。

setAuthorizationRules

public void setAuthorizationRules(List authorizationRules)

参数:

authorizationRules -

• AuthorizationRule用于在实体级别控制用户访问的队列上的 。

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

参数:

autoDeleteOnIdle -

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

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

参数:

defaultMessageTimeToLive -

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

setDuplicationDetectionHistoryTimeWindow

public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)

参数:

duplicationDetectionHistoryTimeWindow -

• 服务维护的重复检测历史记录的持续时间。 最大值为 1 天，最小值为 20 秒。

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

参数:

enableBatchedOperations -

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

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

参数:

enableDeadLetteringOnMessageExpiration -

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

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

参数:

enablePartitioning -

• 如果队列要跨多个消息中转站进行分区，则为 true。

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。

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

参数:

maxSize -

• 队列的最大大小（以 MB 为单位），即为队列分配的内存大小。

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

参数:

requiresDuplicateDetection -

• 如果需要启用重复检测，则为 True。 另请参阅 - isRequiresDuplicateDetection()

setRequiresSession

public void setRequiresSession(boolean requiresSession)

参数:

requiresSession -

• 如此 如果队列应支持会话。

setUserMetadata

public void setUserMetadata(String userMetadata)

参数:

userMetadata -

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