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

CreateQueueOptions 类

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

public final class CreateQueueOptions

表示可为创建队列指定的选项集。

构造函数摘要

构造函数 说明
CreateQueueOptions()

创建具有队列名称的 实例。

CreateQueueOptions(QueueProperties queue)

基于指定的 QueueProperties 实例初始化新实例。

方法摘要

修饰符和类型 方法和描述
List<AuthorizationRule> getAuthorizationRules()

获取用于在实体级别控制用户访问的授权规则。

Duration getAutoDeleteOnIdle()

获取自动删除OnIdle 属性:ISO 8601 时间跨度空闲间隔,在此间隔后自动删除队列。

Duration getDefaultMessageTimeToLive()

获取默认的 MessageTimeToLive 属性:ISO 8601 默认消息时间跨度到实时值。

Duration getDuplicateDetectionHistoryTimeWindow()

获取重复检测历史记录时间窗口属性:定义重复检测历史记录持续时间的 ISO 8601 时间跨度结构。

String getForwardDeadLetteredMessagesTo()

获取转发邮件To 属性:此队列的所有死信邮件都转发到的收件人实体的名称。

String getForwardTo()

获取 forwardTo 属性:发送到队列的所有邮件都转发到的收件人实体的名称。

Duration getLockDuration()

获取 lockDuration 属性:ISO 8601 时间跨度速览锁的持续时间;即,消息为其他接收方锁定的时间量。

int getMaxDeliveryCount()

获取最大传递计数属性:最大传递计数。

long getMaxMessageSizeInKilobytes()

获取最大消息大小InKilobytes 属性:消息的最大大小(以 KB 为单位)。

long getMaxSizeInMegabytes()

获取 maxSizeInMegabytes 属性:队列的最大大小(以兆字节为单位),即为队列分配的内存大小。

EntityStatus getStatus()

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

String getUserMetadata()

获取用户元数据属性:用户可以与说明关联的自定义 metdata。

boolean isBatchedOperationsEnabled()

获取 enableBatchedOperations 属性:指示是否启用服务器端批处理操作的值。

boolean isDeadLetteringOnMessageExpiration()

获取死OnMessageExpiration 属性:一个值,该值指示消息过期时此队列是否支持死信。

boolean isDuplicateDetectionRequired()

获取“需要重复检测”属性:一个值,该值指示此队列是否需要重复检测。

boolean isPartitioningEnabled()

获取 enablePartitioning 属性:一个值,该值指示是否要跨多个消息中转站对队列进行分区。

boolean isSessionRequired()

获取 requiresSession 属性:一个值,该值指示队列是否支持会话的概念。

CreateQueueOptions setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

设置自动删除OnIdle 属性:ISO 8601 时间跨度空闲间隔,在此间隔后自动删除队列。

CreateQueueOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)

设置 enableBatchedOperations 属性:指示是否启用服务器端批处理操作的值。

CreateQueueOptions setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)

设置死OnMessageExpiration 属性:一个值,指示消息过期时此队列是否支持死信。

CreateQueueOptions setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

将默认消息时间ToLive 属性:ISO 8601 默认消息时间跨度设置为实时值。

CreateQueueOptions setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

设置重复检测历史记录时间窗口属性:ISO 8601 时间跨度结构,用于定义重复检测历史记录的持续时间。

CreateQueueOptions setDuplicateDetectionRequired(boolean requiresDuplicateDetection)

设置 需要重复检测 属性:一个值,指示此队列是否需要重复检测。

CreateQueueOptions setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

将转发邮件设置为 属性:此队列的所有死信邮件都转发到的收件人实体的名称。

CreateQueueOptions setForwardTo(String forwardTo)

设置 forwardTo 属性:发送到队列的所有邮件都转发到的收件人实体的名称。

CreateQueueOptions setLockDuration(Duration lockDuration)

设置 lockDuration 属性:ISO 8601 时间跨度速览锁的持续时间;即消息为其他接收方锁定的时间量。

CreateQueueOptions setMaxDeliveryCount(int maxDeliveryCount)

设置最大传递计数属性:最大传递计数。

CreateQueueOptions setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes)

设置最大消息大小InKilobytes 属性:表示默认的最大消息大小 (千字节) 选项仅在高级层中可用。

CreateQueueOptions setMaxSizeInMegabytes(int maxSizeInMegabytes)

设置 maxSizeInMegabytes 属性:队列的最大大小(以兆字节为单位),即为队列分配的内存大小。

CreateQueueOptions setPartitioningEnabled(boolean enablePartitioning)

设置 enablePartitioning 属性:一个值,指示是否要在多个消息中转站之间对队列进行分区。

CreateQueueOptions setSessionRequired(boolean requiresSession)

设置“需要会话”属性:一个指示队列是否支持会话概念的值。

CreateQueueOptions setStatus(EntityStatus status)

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

CreateQueueOptions setUserMetadata(String userMetadata)

设置用户元数据属性:用户可以与说明关联的自定义 metdata。

方法继承自 java.lang.Object

构造函数详细信息

CreateQueueOptions

CreateQueueOptions

public CreateQueueOptions(QueueProperties queue)

基于指定的 QueueProperties 实例初始化新实例。 这对于基于现有队列的属性创建新队列很有用。

Parameters:

queue - 用于创建选项的现有队列。

方法详细信息

getAuthorizationRules

public List getAuthorizationRules()

获取用于在实体级别控制用户访问的授权规则。

Returns:

用于在实体级别控制用户访问的授权规则。

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

获取 autoDeleteOnIdle 属性:ISO 8601 timeSpan 空闲间隔,在此间隔后将自动删除队列。 最短持续时间为 5 分钟。

Returns:

autoDeleteOnIdle 值。

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

获取 defaultMessageTimeToLive 属性:ISO 8601 默认消息时间跨度到实时值。 这是消息过期的持续时间,从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。

Returns:

defaultMessageTimeToLive 值。

getDuplicateDetectionHistoryTimeWindow

public Duration getDuplicateDetectionHistoryTimeWindow()

获取 duplicateDetectionHistoryTimeWindow 属性:ISO 8601 timeSpan 结构,该结构定义重复检测历史记录的持续时间。 默认值为 10 分钟。

Returns:

duplicateDetectionHistoryTimeWindow 值。

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 值。

getMaxMessageSizeInKilobytes

public long getMaxMessageSizeInKilobytes()

获取 maxMessageSizeInKilobytes 属性:消息的最大大小(以 KB 为单位)。

Returns:

maxMessageSizeInKilobytes 值。

getMaxSizeInMegabytes

public long getMaxSizeInMegabytes()

获取 maxSizeInMegabytes 属性:队列的最大大小(以兆字节为单位),即为队列分配的内存大小。

Returns:

maxSizeInMegabytes 值。

getStatus

public EntityStatus getStatus()

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

Returns:

状态值。

getUserMetadata

public String getUserMetadata()

获取 userMetadata 属性:用户可以与说明关联的自定义 metdata。 最大长度为 1024 个字符。

Returns:

userMetadata 值。

isBatchedOperationsEnabled

public boolean isBatchedOperationsEnabled()

获取 enableBatchedOperations 属性:指示是否启用服务器端批处理操作的值。

Returns:

enableBatchedOperations 值。

isDeadLetteringOnMessageExpiration

public boolean isDeadLetteringOnMessageExpiration()

获取 deadLetteringOnMessageExpiration 属性:一个值,该值指示消息过期时此队列是否支持死信。

Returns:

deadLetteringOnMessageExpiration 值。

isDuplicateDetectionRequired

public boolean isDuplicateDetectionRequired()

获取 requiresDuplicateDetection 属性:指示此队列是否需要重复检测的值。

Returns:

requiresDuplicateDetection 值。

isPartitioningEnabled

public boolean isPartitioningEnabled()

获取 enablePartitioning 属性:一个值,该值指示是否要跨多个消息代理对队列进行分区。

Returns:

enablePartitioning 值。

isSessionRequired

public boolean isSessionRequired()

获取 requiresSession 属性:一个值,该值指示队列是否支持会话的概念。

Returns:

需要Session 值。

setAutoDeleteOnIdle

public CreateQueueOptions setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

设置 autoDeleteOnIdle 属性:ISO 8601 timeSpan 空闲间隔,在此间隔后将自动删除队列。 最短持续时间为 5 分钟。

Parameters:

autoDeleteOnIdle - 要设置的 autoDeleteOnIdle 值。

Returns:

CreateQueueOptions 对象本身。

setBatchedOperationsEnabled

public CreateQueueOptions setBatchedOperationsEnabled(boolean enableBatchedOperations)

设置 enableBatchedOperations 属性:指示是否启用服务器端批处理操作的值。

Parameters:

enableBatchedOperations - 要设置的 enableBatchedOperations 值。

Returns:

CreateQueueOptions 对象本身。

setDeadLetteringOnMessageExpiration

public CreateQueueOptions setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)

设置 deadLetteringOnMessageExpiration 属性:一个值,指示消息过期时此队列是否支持死信。

Parameters:

deadLetteringOnMessageExpiration - 要设置的 deadLetteringOnMessageExpiration 值。

Returns:

CreateQueueOptions 对象本身。

setDefaultMessageTimeToLive

public CreateQueueOptions setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

将 defaultMessageTimeToLive 属性:ISO 8601 默认消息时间跨度设置为实时值。 这是消息过期的持续时间,从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。

Parameters:

defaultMessageTimeToLive - 要设置的 defaultMessageTimeToLive 值。

Returns:

CreateQueueOptions 对象本身。

setDuplicateDetectionHistoryTimeWindow

public CreateQueueOptions setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

设置 duplicateDetectionHistoryTimeWindow 属性:ISO 8601 timeSpan 结构,用于定义重复检测历史记录的持续时间。 默认值为 10 分钟。

Parameters:

duplicateDetectionHistoryTimeWindow - 要设置的 duplicateDetectionHistoryTimeWindow 值。

Returns:

CreateQueueOptions 对象本身。

setDuplicateDetectionRequired

public CreateQueueOptions setDuplicateDetectionRequired(boolean requiresDuplicateDetection)

设置 requiresDuplicateDetection 属性:一个值,指示此队列是否需要重复检测。

Parameters:

requiresDuplicateDetection - 需要设置的DuplicateDetection 值。

Returns:

CreateQueueOptions 对象本身。

setForwardDeadLetteredMessagesTo

public CreateQueueOptions setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

设置 forwardDeadLetteredMessagesTo 属性:此队列的所有死信邮件都转发到的收件人实体的名称。

Parameters:

forwardDeadLetteredMessagesTo - 要设置的 forwardDeadLetteredMessagesTo 值。

Returns:

CreateQueueOptions 对象本身。

setForwardTo

public CreateQueueOptions setForwardTo(String forwardTo)

设置 forwardTo 属性:发送到队列的所有邮件都转发到的收件人实体的名称。

Parameters:

forwardTo - 要设置的 forwardTo 值。

Returns:

CreateQueueOptions 对象本身。

setLockDuration

public CreateQueueOptions setLockDuration(Duration lockDuration)

设置 lockDuration 属性:ISO 8601 速览锁的持续时间;也就是说,消息锁定给其他接收方的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。

Parameters:

lockDuration - 要设置的 lockDuration 值。

Returns:

CreateQueueOptions 对象本身。

setMaxDeliveryCount

public CreateQueueOptions setMaxDeliveryCount(int maxDeliveryCount)

设置 maxDeliveryCount 属性:最大传递计数。 传递次数达到此数字后,自动将消息视为死信。 默认值为 10。

Parameters:

maxDeliveryCount - 要设置的 maxDeliveryCount 值。

Returns:

CreateQueueOptions 对象本身。

setMaxMessageSizeInKilobytes

public CreateQueueOptions setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes)

设置 maxMessageSizeInKilobytes 属性:表示默认的最大消息大小 (kb) 选项仅在高级层中可用。 标准层中的默认最大值为 256 KB,在高级层中为 1 MB。 更大的消息大小在预览版中可用。 请参阅 详细信息

Parameters:

maxMessageSizeInKilobytes - 要设置的 maxMessageSizeInKilobytes 值。

Returns:

CreateQueueOptions 对象本身。

setMaxSizeInMegabytes

public CreateQueueOptions setMaxSizeInMegabytes(int maxSizeInMegabytes)

设置 maxSizeInMegabytes 属性:队列的最大大小(以兆字节为单位),即为队列分配的内存大小。

Parameters:

maxSizeInMegabytes - 要设置的 maxSizeInMegabytes 值。

Returns:

CreateQueueOptions 对象本身。

setPartitioningEnabled

public CreateQueueOptions setPartitioningEnabled(boolean enablePartitioning)

设置 enablePartitioning 属性:一个值,该值指示是否要在多个消息中转站之间对队列进行分区。

Parameters:

enablePartitioning - 要设置的 enablePartitioning 值。

Returns:

CreateQueueOptions 对象本身。

setSessionRequired

public CreateQueueOptions setSessionRequired(boolean requiresSession)

设置 requiresSession 属性:一个指示队列是否支持会话概念的值。

Parameters:

requiresSession - 需要设置sSession 值。

Returns:

CreateQueueOptions 对象本身。

setStatus

public CreateQueueOptions setStatus(EntityStatus status)

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

Parameters:

status - 要设置的状态值。

Returns:

CreateQueueOptions 对象本身。

setUserMetadata

public CreateQueueOptions setUserMetadata(String userMetadata)

设置 userMetadata 属性:用户可以与说明关联的自定义 metdata。 最大长度为 1024 个字符。

Parameters:

userMetadata - 要设置的 userMetadata 值。

Returns:

CreateQueueOptions 对象本身。

适用于