public class CmqQueue extends AbstractModel
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 Total number of messages in `Active` status (i.e., unconsumed) in the queue, which is an approximate value.
|
Long |
getBps()
Get Bandwidth limit.
|
Long |
getCreateTime()
Get Queue creation time.
|
Long |
getCreateUin()
Get Creator `Uin`.
|
CmqDeadLetterPolicy |
getDeadLetterPolicy()
Get Dead letter queue policy.
|
CmqDeadLetterSource[] |
getDeadLetterSource()
Get Dead letter queue.
|
Long |
getDelayMsgNum()
Get Number of delayed messages.
|
Long |
getInactiveMsgNum()
Get Total number of messages in `Inactive` status (i.e., being consumed) in the queue, which is an approximate value.
|
Long |
getLastModifyTime()
Get Time when the queue attribute is last modified.
|
Long |
getMaxDelaySeconds()
Get Maximum retention period for inflight messages.
|
Long |
getMaxMsgBacklogSize()
Get Maximum size of heaped messages in bytes.
|
Long |
getMaxMsgHeapNum()
Get Maximum number of heaped messages.
|
Long |
getMaxMsgSize()
Get Maximum message length.
|
Long |
getMaxUnackedMsgNum()
Get The maximum number of unacknowledged messages.
|
Long |
getMinMsgTime()
Get Minimum unconsumed time of message in seconds.
|
Long |
getMsgRetentionSeconds()
Get Message retention period.
|
String |
getNamespaceName()
Get Namespace name
Note: this field may return null, indicating that no valid values can be obtained.
|
Long |
getPollingWaitSeconds()
Get Long polling wait time for message reception.
|
Long |
getQps()
Get Limit of the number of messages produced per second.
|
String |
getQueueId()
Get Message queue ID.
|
String |
getQueueName()
Get Message queue name.
|
Long |
getRetentionSizeInMB()
Get Queue storage space configured for message rewind.
|
Long |
getRewindMsgNum()
Get Number of retained messages which have been deleted by the `DelMsg` API but are still within their rewind time range.
|
Long |
getRewindSeconds()
Get Maximum time range during which a message can be rewound in the queue, which ranges from 0 to 43,200 seconds.
|
Long |
getStatus()
Get Cluster status.
|
Tag[] |
getTags()
Get Associated tag.
|
String |
getTenantId()
Get Tenant ID
Note: this field may return null, indicating that no valid values can be obtained.
|
Boolean |
getTrace()
Get Message trace.
|
Boolean |
getTransaction()
Get Transaction message queue.
|
CmqTransactionPolicy |
getTransactionPolicy()
Get Transaction message policy.
|
Long |
getVisibilityTimeout()
Get Message visibility timeout period.
|
void |
setActiveMsgNum(Long ActiveMsgNum)
Set Total number of messages in `Active` status (i.e., unconsumed) in the queue, which is an approximate value.
|
void |
setBps(Long Bps)
Set Bandwidth limit.
|
void |
setCreateTime(Long CreateTime)
Set Queue creation time.
|
void |
setCreateUin(Long CreateUin)
Set Creator `Uin`.
|
void |
setDeadLetterPolicy(CmqDeadLetterPolicy DeadLetterPolicy)
Set Dead letter queue policy.
|
void |
setDeadLetterSource(CmqDeadLetterSource[] DeadLetterSource)
Set Dead letter queue.
|
void |
setDelayMsgNum(Long DelayMsgNum)
Set Number of delayed messages.
|
void |
setInactiveMsgNum(Long InactiveMsgNum)
Set Total number of messages in `Inactive` status (i.e., being consumed) in the queue, which is an approximate value.
|
void |
setLastModifyTime(Long LastModifyTime)
Set Time when the queue attribute is last modified.
|
void |
setMaxDelaySeconds(Long MaxDelaySeconds)
Set Maximum retention period for inflight messages.
|
void |
setMaxMsgBacklogSize(Long MaxMsgBacklogSize)
Set Maximum size of heaped messages in bytes.
|
void |
setMaxMsgHeapNum(Long MaxMsgHeapNum)
Set Maximum number of heaped messages.
|
void |
setMaxMsgSize(Long MaxMsgSize)
Set Maximum message length.
|
void |
setMaxUnackedMsgNum(Long MaxUnackedMsgNum)
Set The maximum number of unacknowledged messages.
|
void |
setMinMsgTime(Long MinMsgTime)
Set Minimum unconsumed time of message in seconds.
|
void |
setMsgRetentionSeconds(Long MsgRetentionSeconds)
Set Message retention period.
|
void |
setNamespaceName(String NamespaceName)
Set Namespace name
Note: this field may return null, indicating that no valid values can be obtained.
|
void |
setPollingWaitSeconds(Long PollingWaitSeconds)
Set Long polling wait time for message reception.
|
void |
setQps(Long Qps)
Set Limit of the number of messages produced per second.
|
void |
setQueueId(String QueueId)
Set Message queue ID.
|
void |
setQueueName(String QueueName)
Set Message queue name.
|
void |
setRetentionSizeInMB(Long RetentionSizeInMB)
Set Queue storage space configured for message rewind.
|
void |
setRewindMsgNum(Long RewindMsgNum)
Set Number of retained messages which have been deleted by the `DelMsg` API but are still within their rewind time range.
|
void |
setRewindSeconds(Long RewindSeconds)
Set Maximum time range during which a message can be rewound in the queue, which ranges from 0 to 43,200 seconds.
|
void |
setStatus(Long Status)
Set Cluster status.
|
void |
setTags(Tag[] Tags)
Set Associated tag.
|
void |
setTenantId(String TenantId)
Set Tenant ID
Note: this field may return null, indicating that no valid values can be obtained.
|
void |
setTrace(Boolean Trace)
Set Message trace.
|
void |
setTransaction(Boolean Transaction)
Set Transaction message queue.
|
void |
setTransactionPolicy(CmqTransactionPolicy TransactionPolicy)
Set Transaction message policy.
|
void |
setVisibilityTimeout(Long VisibilityTimeout)
Set Message visibility timeout period.
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public CmqQueue()
public CmqQueue(CmqQueue source)
public String getQueueId()
public void setQueueId(String QueueId)
QueueId
- Message queue ID.public String getQueueName()
public void setQueueName(String QueueName)
QueueName
- Message queue name.public Long getQps()
public void setQps(Long Qps)
Qps
- Limit of the number of messages produced per second. The value for consumed messages is 1.1 times this value.
Note: this field may return null, indicating that no valid values can be obtained.public Long getBps()
public void setBps(Long Bps)
Bps
- Bandwidth limit.
Note: this field may return null, indicating that no valid values can be obtained.public Long getMaxDelaySeconds()
public void setMaxDelaySeconds(Long MaxDelaySeconds)
MaxDelaySeconds
- Maximum retention period for inflight messages.
Note: this field may return null, indicating that no valid values can be obtained.public Long getMaxMsgHeapNum()
public void setMaxMsgHeapNum(Long MaxMsgHeapNum)
MaxMsgHeapNum
- Maximum number of heaped messages. The value range is 1,000,000–10,000,000 during the beta test and can be 1,000,000–1,000,000,000 after the product is officially released. The default value is 10,000,000 during the beta test and will be 100,000,000 after the product is officially released.public Long getPollingWaitSeconds()
public void setPollingWaitSeconds(Long PollingWaitSeconds)
PollingWaitSeconds
- Long polling wait time for message reception. Value range: 0–30 seconds. Default value: 0.
Note: this field may return null, indicating that no valid values can be obtained.public Long getMsgRetentionSeconds()
public void setMsgRetentionSeconds(Long MsgRetentionSeconds)
MsgRetentionSeconds
- Message retention period. Value range: 60–1296000 seconds (i.e., 1 minute–15 days). Default value: 345600 (i.e., 4 days).
Note: this field may return null, indicating that no valid values can be obtained.public Long getVisibilityTimeout()
public void setVisibilityTimeout(Long VisibilityTimeout)
VisibilityTimeout
- Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30.
Note: this field may return null, indicating that no valid values can be obtained.public Long getMaxMsgSize()
public void setMaxMsgSize(Long MaxMsgSize)
MaxMsgSize
- Maximum message length. Value range: 1024–1048576 bytes (i.e., 1–1024 KB). Default value: 65536.
Note: this field may return null, indicating that no valid values can be obtained.public Long getRewindSeconds()
public void setRewindSeconds(Long RewindSeconds)
RewindSeconds
- Maximum time range during which a message can be rewound in the queue, which ranges from 0 to 43,200 seconds. 0 indicates that message rewind is disabled.
Note: this field may return null, indicating that no valid values can be obtained.public Long getCreateTime()
public void setCreateTime(Long CreateTime)
CreateTime
- Queue creation time. A Unix timestamp accurate down to the millisecond will be returned.
Note: this field may return null, indicating that no valid values can be obtained.public Long getLastModifyTime()
public void setLastModifyTime(Long LastModifyTime)
LastModifyTime
- Time when the queue attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned.
Note: this field may return null, indicating that no valid values can be obtained.public Long getActiveMsgNum()
public void setActiveMsgNum(Long ActiveMsgNum)
ActiveMsgNum
- Total number of messages in `Active` status (i.e., unconsumed) in the queue, which is an approximate value.
Note: this field may return null, indicating that no valid values can be obtained.public Long getInactiveMsgNum()
public void setInactiveMsgNum(Long InactiveMsgNum)
InactiveMsgNum
- Total number of messages in `Inactive` status (i.e., being consumed) in the queue, which is an approximate value.
Note: this field may return null, indicating that no valid values can be obtained.public Long getDelayMsgNum()
public void setDelayMsgNum(Long DelayMsgNum)
DelayMsgNum
- Number of delayed messages.
Note: this field may return null, indicating that no valid values can be obtained.public Long getRewindMsgNum()
public void setRewindMsgNum(Long RewindMsgNum)
RewindMsgNum
- Number of retained messages which have been deleted by the `DelMsg` API but are still within their rewind time range.
Note: this field may return null, indicating that no valid values can be obtained.public Long getMinMsgTime()
public void setMinMsgTime(Long MinMsgTime)
MinMsgTime
- Minimum unconsumed time of message in seconds.
Note: this field may return null, indicating that no valid values can be obtained.public Boolean getTransaction()
public void setTransaction(Boolean Transaction)
Transaction
- Transaction message queue. true: transaction message type; false: other message types.
Note: this field may return null, indicating that no valid values can be obtained.public CmqDeadLetterSource[] getDeadLetterSource()
public void setDeadLetterSource(CmqDeadLetterSource[] DeadLetterSource)
DeadLetterSource
- Dead letter queue.
Note: this field may return null, indicating that no valid values can be obtained.public CmqDeadLetterPolicy getDeadLetterPolicy()
public void setDeadLetterPolicy(CmqDeadLetterPolicy DeadLetterPolicy)
DeadLetterPolicy
- Dead letter queue policy.
Note: this field may return null, indicating that no valid values can be obtained.public CmqTransactionPolicy getTransactionPolicy()
public void setTransactionPolicy(CmqTransactionPolicy TransactionPolicy)
TransactionPolicy
- Transaction message policy.
Note: this field may return null, indicating that no valid values can be obtained.public Long getCreateUin()
public void setCreateUin(Long CreateUin)
CreateUin
- Creator `Uin`.
Note: this field may return null, indicating that no valid values can be obtained.public Tag[] getTags()
public void setTags(Tag[] Tags)
Tags
- Associated tag.
Note: this field may return null, indicating that no valid values can be obtained.public Boolean getTrace()
public void setTrace(Boolean Trace)
Trace
- Message trace. true: enabled; false: not enabled
Note: this field may return null, indicating that no valid values can be obtained.public String getTenantId()
public void setTenantId(String TenantId)
TenantId
- Tenant ID
Note: this field may return null, indicating that no valid values can be obtained.public String getNamespaceName()
public void setNamespaceName(String NamespaceName)
NamespaceName
- Namespace name
Note: this field may return null, indicating that no valid values can be obtained.public Long getStatus()
public void setStatus(Long Status)
Status
- Cluster status. 0: creating; 1: normal; 2: terminating; 3: deleted; 4. isolated; 5. creation failed; 6: deletion failed
Note: this field may return `null`, indicating that no valid values can be obtained.public Long getMaxUnackedMsgNum()
public void setMaxUnackedMsgNum(Long MaxUnackedMsgNum)
MaxUnackedMsgNum
- The maximum number of unacknowledged messages.
Note: this field may return `null`, indicating that no valid values can be obtained.public Long getMaxMsgBacklogSize()
public void setMaxMsgBacklogSize(Long MaxMsgBacklogSize)
MaxMsgBacklogSize
- Maximum size of heaped messages in bytes.
Note: this field may return `null`, indicating that no valid values can be obtained.public Long getRetentionSizeInMB()
public void setRetentionSizeInMB(Long RetentionSizeInMB)
RetentionSizeInMB
- Queue storage space configured for message rewind. Value range: 1,024-10,240 MB (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.
Note: This field may return `null`, indicating that no valid values can be obtained.Copyright © 2023. All rights reserved.