com.tencentcloudapi.tdmq.v20200217.models

Class ModifyCmqQueueAttributeRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.ModifyCmqQueueAttributeRequest

public class ModifyCmqQueueAttributeRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ModifyCmqQueueAttributeRequest()
ModifyCmqQueueAttributeRequest(ModifyCmqQueueAttributeRequest 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.

Method Summary

Modifier and Type	Method and Description
String	getDeadLetterQueueName() Get Dead letter queue name
Long	getFirstQueryInterval() Get First query time
Long	getMaxMsgHeapNum() Get Maximum number of heaped messages.
Long	getMaxMsgSize() Get Max message size, which defaults to 1,024 KB for the queue of TDMQ for CMQ and cannot be modified.
Long	getMaxQueryCount() Get Maximum number of queries
Long	getMaxReceiveCount() Get Maximum number of receipts
Long	getMaxTimeToLive() Get Maximum period in seconds before an unconsumed message expires, which is required if `MaxTimeToLivepolicy` is 1.
Long	getMsgRetentionSeconds() Get The max period during which a message is retained before it is automatically acknowledged.
Long	getPolicy() Get Dead letter queue policy
Long	getPollingWaitSeconds() Get Long polling wait time for message reception.
String	getQueueName() Get Queue name, which must be unique under the same account in the same region.
Long	getRetentionSizeInMB() Get Queue storage space configured for message rewind.
Long	getRewindSeconds() Get Rewindable time of messages in the queue.
Boolean	getTrace() Get Whether to enable message trace.
Long	getTransaction() Get Whether to enable transaction.
Long	getVisibilityTimeout() Get Message visibility timeout period.
void	setDeadLetterQueueName(String DeadLetterQueueName) Set Dead letter queue name
void	setFirstQueryInterval(Long FirstQueryInterval) Set First query time
void	setMaxMsgHeapNum(Long MaxMsgHeapNum) Set Maximum number of heaped messages.
void	setMaxMsgSize(Long MaxMsgSize) Set Max message size, which defaults to 1,024 KB for the queue of TDMQ for CMQ and cannot be modified.
void	setMaxQueryCount(Long MaxQueryCount) Set Maximum number of queries
void	setMaxReceiveCount(Long MaxReceiveCount) Set Maximum number of receipts
void	setMaxTimeToLive(Long MaxTimeToLive) Set Maximum period in seconds before an unconsumed message expires, which is required if `MaxTimeToLivepolicy` is 1.
void	setMsgRetentionSeconds(Long MsgRetentionSeconds) Set The max period during which a message is retained before it is automatically acknowledged.
void	setPolicy(Long Policy) Set Dead letter queue policy
void	setPollingWaitSeconds(Long PollingWaitSeconds) Set Long polling wait time for message reception.
void	setQueueName(String QueueName) Set Queue name, which must be unique under the same account in the same region.
void	setRetentionSizeInMB(Long RetentionSizeInMB) Set Queue storage space configured for message rewind.
void	setRewindSeconds(Long RewindSeconds) Set Rewindable time of messages in the queue.
void	setTrace(Boolean Trace) Set Whether to enable message trace.
void	setTransaction(Long Transaction) Set Whether to enable transaction.
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.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModifyCmqQueueAttributeRequest

public ModifyCmqQueueAttributeRequest()

ModifyCmqQueueAttributeRequest

public ModifyCmqQueueAttributeRequest(ModifyCmqQueueAttributeRequest 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.

Method Detail

getQueueName

public String getQueueName()

Get Queue name, which must be unique under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.

Returns:

QueueName Queue name, which must be unique under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.

setQueueName

public void setQueueName(String QueueName)

Set Queue name, which must be unique under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.

Parameters:

QueueName - Queue name, which must be unique under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.

getMaxMsgHeapNum

public Long getMaxMsgHeapNum()

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

Returns:

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.

setMaxMsgHeapNum

public void setMaxMsgHeapNum(Long MaxMsgHeapNum)

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

Parameters:

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.

getPollingWaitSeconds

public Long getPollingWaitSeconds()

Get Long polling wait time for message reception. Value range: 0–30 seconds. Default value: 0.

Returns:

PollingWaitSeconds Long polling wait time for message reception. Value range: 0–30 seconds. Default value: 0.

setPollingWaitSeconds

public void setPollingWaitSeconds(Long PollingWaitSeconds)

Set Long polling wait time for message reception. Value range: 0–30 seconds. Default value: 0.

Parameters:

PollingWaitSeconds - Long polling wait time for message reception. Value range: 0–30 seconds. Default value: 0.

getVisibilityTimeout

public Long getVisibilityTimeout()

Get Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30.

Returns:

VisibilityTimeout Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30.

setVisibilityTimeout

public void setVisibilityTimeout(Long VisibilityTimeout)

Set Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30.

Parameters:

VisibilityTimeout - Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30.

getMaxMsgSize

public Long getMaxMsgSize()

Get Max message size, which defaults to 1,024 KB for the queue of TDMQ for CMQ and cannot be modified.

Returns:

MaxMsgSize Max message size, which defaults to 1,024 KB for the queue of TDMQ for CMQ and cannot be modified.

setMaxMsgSize

public void setMaxMsgSize(Long MaxMsgSize)

Set Max message size, which defaults to 1,024 KB for the queue of TDMQ for CMQ and cannot be modified.

Parameters:

MaxMsgSize - Max message size, which defaults to 1,024 KB for the queue of TDMQ for CMQ and cannot be modified.

getMsgRetentionSeconds

public Long getMsgRetentionSeconds()

Get The max period during which a message is retained before it is automatically acknowledged. Value range: 30-43,200 seconds (30 seconds to 12 hours). Default value: 3600 seconds (1 hour).

Returns:

MsgRetentionSeconds The max period during which a message is retained before it is automatically acknowledged. Value range: 30-43,200 seconds (30 seconds to 12 hours). Default value: 3600 seconds (1 hour).

setMsgRetentionSeconds

public void setMsgRetentionSeconds(Long MsgRetentionSeconds)

Set The max period during which a message is retained before it is automatically acknowledged. Value range: 30-43,200 seconds (30 seconds to 12 hours). Default value: 3600 seconds (1 hour).

Parameters:

MsgRetentionSeconds - The max period during which a message is retained before it is automatically acknowledged. Value range: 30-43,200 seconds (30 seconds to 12 hours). Default value: 3600 seconds (1 hour).

getRewindSeconds

public Long getRewindSeconds()

Get Rewindable time of messages in the queue. Value range: 0-1,296,000s (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.

Returns:

RewindSeconds Rewindable time of messages in the queue. Value range: 0-1,296,000s (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.

setRewindSeconds

public void setRewindSeconds(Long RewindSeconds)

Set Rewindable time of messages in the queue. Value range: 0-1,296,000s (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.

Parameters:

RewindSeconds - Rewindable time of messages in the queue. Value range: 0-1,296,000s (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.

getFirstQueryInterval

public Long getFirstQueryInterval()

Get First query time

Returns:

FirstQueryInterval First query time

setFirstQueryInterval

public void setFirstQueryInterval(Long FirstQueryInterval)

Set First query time

Parameters:

FirstQueryInterval - First query time

getMaxQueryCount

public Long getMaxQueryCount()

Get Maximum number of queries

Returns:

MaxQueryCount Maximum number of queries

setMaxQueryCount

public void setMaxQueryCount(Long MaxQueryCount)

Set Maximum number of queries

Parameters:

MaxQueryCount - Maximum number of queries

getDeadLetterQueueName

public String getDeadLetterQueueName()

Get Dead letter queue name

Returns:

DeadLetterQueueName Dead letter queue name

setDeadLetterQueueName

public void setDeadLetterQueueName(String DeadLetterQueueName)

Set Dead letter queue name

Parameters:

DeadLetterQueueName - Dead letter queue name

getMaxTimeToLive

public Long getMaxTimeToLive()

Get Maximum period in seconds before an unconsumed message expires, which is required if `MaxTimeToLivepolicy` is 1. Value range: 300–43200. This value should be smaller than `MsgRetentionSeconds` (maximum message retention period)

Returns:

MaxTimeToLive Maximum period in seconds before an unconsumed message expires, which is required if `MaxTimeToLivepolicy` is 1. Value range: 300–43200. This value should be smaller than `MsgRetentionSeconds` (maximum message retention period)

setMaxTimeToLive

public void setMaxTimeToLive(Long MaxTimeToLive)

Set Maximum period in seconds before an unconsumed message expires, which is required if `MaxTimeToLivepolicy` is 1. Value range: 300–43200. This value should be smaller than `MsgRetentionSeconds` (maximum message retention period)

Parameters:

MaxTimeToLive - Maximum period in seconds before an unconsumed message expires, which is required if `MaxTimeToLivepolicy` is 1. Value range: 300–43200. This value should be smaller than `MsgRetentionSeconds` (maximum message retention period)

getMaxReceiveCount

public Long getMaxReceiveCount()

Get Maximum number of receipts

Returns:

MaxReceiveCount Maximum number of receipts

setMaxReceiveCount

public void setMaxReceiveCount(Long MaxReceiveCount)

Set Maximum number of receipts

Parameters:

MaxReceiveCount - Maximum number of receipts

getPolicy

public Long getPolicy()

Get Dead letter queue policy

Returns:

Policy Dead letter queue policy

setPolicy

public void setPolicy(Long Policy)

Set Dead letter queue policy

Parameters:

Policy - Dead letter queue policy

getTrace

public Boolean getTrace()

Get Whether to enable message trace. true: yes; false: no. If this field is left empty, the feature will not be enabled.

Returns:

Trace Whether to enable message trace. true: yes; false: no. If this field is left empty, the feature will not be enabled.

setTrace

public void setTrace(Boolean Trace)

Set Whether to enable message trace. true: yes; false: no. If this field is left empty, the feature will not be enabled.

Parameters:

Trace - Whether to enable message trace. true: yes; false: no. If this field is left empty, the feature will not be enabled.

getTransaction

public Long getTransaction()

Get Whether to enable transaction. 1: yes; 0: no

Returns:

Transaction Whether to enable transaction. 1: yes; 0: no

setTransaction

public void setTransaction(Long Transaction)

Set Whether to enable transaction. 1: yes; 0: no

Parameters:

Transaction - Whether to enable transaction. 1: yes; 0: no

getRetentionSizeInMB

public Long getRetentionSizeInMB()

Get Queue storage space configured for message rewind. Value range: 10,240-512,000 MB (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.

Returns:

RetentionSizeInMB Queue storage space configured for message rewind. Value range: 10,240-512,000 MB (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.

setRetentionSizeInMB

public void setRetentionSizeInMB(Long RetentionSizeInMB)

Set Queue storage space configured for message rewind. Value range: 10,240-512,000 MB (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.

Parameters:

RetentionSizeInMB - Queue storage space configured for message rewind. Value range: 10,240-512,000 MB (if message rewind is enabled). The value “0” indicates that message rewind is not enabled.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel