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

TopicDescription 类

包:

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

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

表示主题的元数据说明。

构造函数摘要

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

方法摘要

修饰符和类型	方法和描述
boolean	equals(Object o)
List<AuthorizationRule>	getAuthorizationRules()
Duration	getAutoDeleteOnIdle()
Duration	getDefaultMessageTimeToLive() 生存时间是消息过期的持续时间，从消息发送到服务总线时开始。
Duration	getDuplicationDetectionHistoryTimeWindow()
EntityStatus	getEntityStatus() 获取实体的状态。
long	getMaxSizeInMB()
String	getPath()
String	getUserMetadata()
int	hashCode()
boolean	isEnableBatchedOperations()
boolean	isEnablePartitioning()
boolean	isRequiresDuplicateDetection() 如果启用，将丢弃具有相同 getMessageId() 消息并在 持续时间内发送到队列的 #getDuplicationDetectionHistoryTimeWindow 重复消息。
boolean	isSupportOrdering()
void	setAuthorizationRules(List<AuthorizationRule> authorizationRules)
void	setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void	setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
void	setEnableBatchedOperations(boolean enableBatchedOperations)
void	setEnablePartitioning(boolean enablePartitioning)
void	setEntityStatus(EntityStatus status)
void	setMaxSizeInMB(long maxSize)
void	setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
void	setSupportOrdering(boolean supportOrdering)
void	setUserMetadata(String userMetadata)

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

构造函数详细信息

TopicDescription

public TopicDescription(String path)

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

参数:

path -

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

方法详细信息

equals

public boolean equals(Object o)

替代:

TopicDescription.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()

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

返回:

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

getMaxSizeInMB

public long getMaxSizeInMB()

返回:

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

getPath

public String getPath()

返回:

主题的路径。

getUserMetadata

public String getUserMetadata()

返回:

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

hashCode

public int hashCode()

替代:

TopicDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

返回:

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

isEnablePartitioning

public boolean isEnablePartitioning()

返回:

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

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

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

返回:

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

isSupportOrdering

public boolean isSupportOrdering()

返回:

定义是否需要维护排序。 如果为 true，则发送到主题的消息将按顺序转发到订阅。 默认为 false

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 -

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

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

参数:

enablePartitioning -

• 如果主题要跨多个消息中转站分区，则为 true。

setEntityStatus

public void setEntityStatus(EntityStatus status)

参数:

status -

• 主题的状态 (启用/禁用) 。 禁用实体后，该实体无法发送或接收消息。

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

参数:

maxSize -

• 设置主题的最大大小（以兆字节为单位），即为主题分配的内存大小。

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

参数:

requiresDuplicateDetection -

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

setSupportOrdering

public void setSupportOrdering(boolean supportOrdering)

参数:

supportOrdering -

• 定义是否需要维护排序。 如果为 true，则发送到主题的消息将按顺序转发到订阅。

setUserMetadata

public void setUserMetadata(String userMetadata)

参数:

userMetadata -

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