public class CmqQueue extends AbstractModel
header, skipSign| Constructor and Description | 
|---|
| CmqQueue() | 
| CmqQueue(CmqQueue source)NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
       and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy. | 
| Modifier and Type | Method and Description | 
|---|---|
| Long | getActiveMsgNum()Get 在队列中处于 Active 状态(不处于被消费状态)的消息总数,为近似值。 | 
| Long | getBps()Get 带宽限制。 | 
| Long | getCreateTime()Get 队列的创建时间。返回 Unix 时间戳,精确到毫秒。 | 
| Long | getCreateUin()Get 创建者Uin。
注意:此字段可能返回 null,表示取不到有效值。 | 
| CmqDeadLetterPolicy | getDeadLetterPolicy()Get 死信队列策略。
注意:此字段可能返回 null,表示取不到有效值。 | 
| CmqDeadLetterSource[] | getDeadLetterSource()Get 死信队列。
注意:此字段可能返回 null,表示取不到有效值。 | 
| Long | getDelayMsgNum()Get 延迟消息数。
注意:此字段可能返回 null,表示取不到有效值。 | 
| Long | getInactiveMsgNum()Get 在队列中处于 Inactive 状态(正处于被消费状态)的消息总数,为近似值。 | 
| Long | getLastModifyTime()Get 最后一次修改队列属性的时间。返回 Unix 时间戳,精确到毫秒。 | 
| Long | getMaxDelaySeconds()Get 飞行消息最大保留时间,需要小于消息保留周期。 | 
| Long | getMaxMsgBacklogSize()Get 最大消息堆积大小(字节) | 
| Long | getMaxMsgHeapNum()Get 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。 | 
| Long | getMaxMsgSize()Get 消息最大长度。取值范围1024 - 1048576 Byte(即1K - 1024K),默认值65536。 | 
| Long | getMaxUnackedMsgNum()Get 最大未确认消息数量 | 
| Long | getMinMsgTime()Get 消息最小未消费时间,单位为秒。
注意:此字段可能返回 null,表示取不到有效值。 | 
| Long | getMsgRetentionSeconds()Get 消息保留周期。取值范围60-1296000秒(1min-15天),默认值345600秒(4 天)。 | 
| String | getNamespaceName()Get 命名空间名称 | 
| Long | getPollingWaitSeconds()Get 消息接收长轮询等待时间。取值范围0 - 30秒,默认值0。 | 
| Long | getQps()Get 每秒钟生产消息条数的限制,消费消息的大小是该值的1.1倍。 | 
| String | getQueueId()Get 消息队列ID。 | 
| String | getQueueName()Get 消息队列名字。 | 
| Long | getRetentionSizeInMB()Get 队列可回溯存储空间,取值范围1024MB - 10240MB,0表示不开启 | 
| Long | getRewindMsgNum()Get 已调用 DelMsg 接口删除,但还在回溯保留时间内的消息数量。
注意:此字段可能返回 null,表示取不到有效值。 | 
| Long | getRewindSeconds()Get 回溯队列的消息回溯时间最大值,取值范围0 - 43200秒,0表示不开启消息回溯。 | 
| Long | getStatus()Get 集群状态,0:创建中,1:正常,2:销毁中,3:已删除,4: 隔离中,5:创建失败,6: 删除失败 | 
| Tag[] | getTags()Get 关联的标签。
注意:此字段可能返回 null,表示取不到有效值。 | 
| String | getTenantId()Get 租户id | 
| Boolean | getTrace()Get 消息轨迹。true表示开启,false表示不开启。
注意:此字段可能返回 null,表示取不到有效值。 | 
| Boolean | getTransaction()Get 事务消息队列。true表示是事务消息,false表示不是事务消息。
注意:此字段可能返回 null,表示取不到有效值。 | 
| CmqTransactionPolicy | getTransactionPolicy()Get 事务消息策略。
注意:此字段可能返回 null,表示取不到有效值。 | 
| Long | getVisibilityTimeout()Get 消息可见性超时。取值范围1 - 43200秒(即12小时内),默认值30。 | 
| void | setActiveMsgNum(Long ActiveMsgNum)Set 在队列中处于 Active 状态(不处于被消费状态)的消息总数,为近似值。 | 
| void | setBps(Long Bps)Set 带宽限制。 | 
| void | setCreateTime(Long CreateTime)Set 队列的创建时间。返回 Unix 时间戳,精确到毫秒。 | 
| void | setCreateUin(Long CreateUin)Set 创建者Uin。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setDeadLetterPolicy(CmqDeadLetterPolicy DeadLetterPolicy)Set 死信队列策略。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setDeadLetterSource(CmqDeadLetterSource[] DeadLetterSource)Set 死信队列。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setDelayMsgNum(Long DelayMsgNum)Set 延迟消息数。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setInactiveMsgNum(Long InactiveMsgNum)Set 在队列中处于 Inactive 状态(正处于被消费状态)的消息总数,为近似值。 | 
| void | setLastModifyTime(Long LastModifyTime)Set 最后一次修改队列属性的时间。返回 Unix 时间戳,精确到毫秒。 | 
| void | setMaxDelaySeconds(Long MaxDelaySeconds)Set 飞行消息最大保留时间,需要小于消息保留周期。 | 
| void | setMaxMsgBacklogSize(Long MaxMsgBacklogSize)Set 最大消息堆积大小(字节) | 
| void | setMaxMsgHeapNum(Long MaxMsgHeapNum)Set 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。 | 
| void | setMaxMsgSize(Long MaxMsgSize)Set 消息最大长度。取值范围1024 - 1048576 Byte(即1K - 1024K),默认值65536。 | 
| void | setMaxUnackedMsgNum(Long MaxUnackedMsgNum)Set 最大未确认消息数量 | 
| void | setMinMsgTime(Long MinMsgTime)Set 消息最小未消费时间,单位为秒。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setMsgRetentionSeconds(Long MsgRetentionSeconds)Set 消息保留周期。取值范围60-1296000秒(1min-15天),默认值345600秒(4 天)。 | 
| void | setNamespaceName(String NamespaceName)Set 命名空间名称 | 
| void | setPollingWaitSeconds(Long PollingWaitSeconds)Set 消息接收长轮询等待时间。取值范围0 - 30秒,默认值0。 | 
| void | setQps(Long Qps)Set 每秒钟生产消息条数的限制,消费消息的大小是该值的1.1倍。 | 
| void | setQueueId(String QueueId)Set 消息队列ID。 | 
| void | setQueueName(String QueueName)Set 消息队列名字。 | 
| void | setRetentionSizeInMB(Long RetentionSizeInMB)Set 队列可回溯存储空间,取值范围1024MB - 10240MB,0表示不开启 | 
| void | setRewindMsgNum(Long RewindMsgNum)Set 已调用 DelMsg 接口删除,但还在回溯保留时间内的消息数量。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setRewindSeconds(Long RewindSeconds)Set 回溯队列的消息回溯时间最大值,取值范围0 - 43200秒,0表示不开启消息回溯。 | 
| void | setStatus(Long Status)Set 集群状态,0:创建中,1:正常,2:销毁中,3:已删除,4: 隔离中,5:创建失败,6: 删除失败 | 
| void | setTags(Tag[] Tags)Set 关联的标签。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setTenantId(String TenantId)Set 租户id | 
| void | setTrace(Boolean Trace)Set 消息轨迹。true表示开启,false表示不开启。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setTransaction(Boolean Transaction)Set 事务消息队列。true表示是事务消息,false表示不是事务消息。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setTransactionPolicy(CmqTransactionPolicy TransactionPolicy)Set 事务消息策略。
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setVisibilityTimeout(Long VisibilityTimeout)Set 消息可见性超时。取值范围1 - 43200秒(即12小时内),默认值30。 | 
| void | toMap(HashMap<String,String> map,
     String prefix)Internal implementation, normal users should not use it. | 
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic CmqQueue()
public CmqQueue(CmqQueue source)
public String getQueueId()
public void setQueueId(String QueueId)
QueueId - 消息队列ID。public String getQueueName()
public void setQueueName(String QueueName)
QueueName - 消息队列名字。public Long getQps()
public void setQps(Long Qps)
Qps - 每秒钟生产消息条数的限制,消费消息的大小是该值的1.1倍。public Long getBps()
public void setBps(Long Bps)
Bps - 带宽限制。public Long getMaxDelaySeconds()
public void setMaxDelaySeconds(Long MaxDelaySeconds)
MaxDelaySeconds - 飞行消息最大保留时间,需要小于消息保留周期。public Long getMaxMsgHeapNum()
public void setMaxMsgHeapNum(Long MaxMsgHeapNum)
MaxMsgHeapNum - 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000,正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000,正式上线后为 100,000,000。public Long getPollingWaitSeconds()
public void setPollingWaitSeconds(Long PollingWaitSeconds)
PollingWaitSeconds - 消息接收长轮询等待时间。取值范围0 - 30秒,默认值0。public Long getMsgRetentionSeconds()
public void setMsgRetentionSeconds(Long MsgRetentionSeconds)
MsgRetentionSeconds - 消息保留周期。取值范围60-1296000秒(1min-15天),默认值345600秒(4 天)。public Long getVisibilityTimeout()
public void setVisibilityTimeout(Long VisibilityTimeout)
VisibilityTimeout - 消息可见性超时。取值范围1 - 43200秒(即12小时内),默认值30。public Long getMaxMsgSize()
public void setMaxMsgSize(Long MaxMsgSize)
MaxMsgSize - 消息最大长度。取值范围1024 - 1048576 Byte(即1K - 1024K),默认值65536。public Long getRewindSeconds()
public void setRewindSeconds(Long RewindSeconds)
RewindSeconds - 回溯队列的消息回溯时间最大值,取值范围0 - 43200秒,0表示不开启消息回溯。public Long getCreateTime()
public void setCreateTime(Long CreateTime)
CreateTime - 队列的创建时间。返回 Unix 时间戳,精确到毫秒。public Long getLastModifyTime()
public void setLastModifyTime(Long LastModifyTime)
LastModifyTime - 最后一次修改队列属性的时间。返回 Unix 时间戳,精确到毫秒。public Long getActiveMsgNum()
public void setActiveMsgNum(Long ActiveMsgNum)
ActiveMsgNum - 在队列中处于 Active 状态(不处于被消费状态)的消息总数,为近似值。public Long getInactiveMsgNum()
public void setInactiveMsgNum(Long InactiveMsgNum)
InactiveMsgNum - 在队列中处于 Inactive 状态(正处于被消费状态)的消息总数,为近似值。public Long getDelayMsgNum()
public void setDelayMsgNum(Long DelayMsgNum)
DelayMsgNum - 延迟消息数。
注意:此字段可能返回 null,表示取不到有效值。public Long getRewindMsgNum()
public void setRewindMsgNum(Long RewindMsgNum)
RewindMsgNum - 已调用 DelMsg 接口删除,但还在回溯保留时间内的消息数量。
注意:此字段可能返回 null,表示取不到有效值。public Long getMinMsgTime()
public void setMinMsgTime(Long MinMsgTime)
MinMsgTime - 消息最小未消费时间,单位为秒。
注意:此字段可能返回 null,表示取不到有效值。public Boolean getTransaction()
public void setTransaction(Boolean Transaction)
Transaction - 事务消息队列。true表示是事务消息,false表示不是事务消息。
注意:此字段可能返回 null,表示取不到有效值。public CmqDeadLetterSource[] getDeadLetterSource()
public void setDeadLetterSource(CmqDeadLetterSource[] DeadLetterSource)
DeadLetterSource - 死信队列。
注意:此字段可能返回 null,表示取不到有效值。public CmqDeadLetterPolicy getDeadLetterPolicy()
public void setDeadLetterPolicy(CmqDeadLetterPolicy DeadLetterPolicy)
DeadLetterPolicy - 死信队列策略。
注意:此字段可能返回 null,表示取不到有效值。public CmqTransactionPolicy getTransactionPolicy()
public void setTransactionPolicy(CmqTransactionPolicy TransactionPolicy)
TransactionPolicy - 事务消息策略。
注意:此字段可能返回 null,表示取不到有效值。public Long getCreateUin()
public void setCreateUin(Long CreateUin)
CreateUin - 创建者Uin。
注意:此字段可能返回 null,表示取不到有效值。public Tag[] getTags()
public void setTags(Tag[] Tags)
Tags - 关联的标签。
注意:此字段可能返回 null,表示取不到有效值。public Boolean getTrace()
public void setTrace(Boolean Trace)
Trace - 消息轨迹。true表示开启,false表示不开启。
注意:此字段可能返回 null,表示取不到有效值。public String getTenantId()
public void setTenantId(String TenantId)
TenantId - 租户idpublic String getNamespaceName()
public void setNamespaceName(String NamespaceName)
NamespaceName - 命名空间名称public Long getStatus()
public void setStatus(Long Status)
Status - 集群状态,0:创建中,1:正常,2:销毁中,3:已删除,4: 隔离中,5:创建失败,6: 删除失败public Long getMaxUnackedMsgNum()
public void setMaxUnackedMsgNum(Long MaxUnackedMsgNum)
MaxUnackedMsgNum - 最大未确认消息数量public Long getMaxMsgBacklogSize()
public void setMaxMsgBacklogSize(Long MaxMsgBacklogSize)
MaxMsgBacklogSize - 最大消息堆积大小(字节)public Long getRetentionSizeInMB()
public void setRetentionSizeInMB(Long RetentionSizeInMB)
RetentionSizeInMB - 队列可回溯存储空间,取值范围1024MB - 10240MB,0表示不开启Copyright © 2025. All rights reserved.