com.tencentcloudapi.tdmq.v20200217.models

Class CreateCmqQueueRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.CreateCmqQueueRequest

public class CreateCmqQueueRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateCmqQueueRequest()
CreateCmqQueueRequest(CreateCmqQueueRequest 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 lookback interval
Long	getMaxMsgHeapNum() Get Maximum number of heaped messages.
Long	getMaxMsgSize() Get Maximum message length.
Long	getMaxQueryCount() Get Maximum number of lookbacks
Long	getMaxReceiveCount() Get Maximum receipt times.
Long	getMaxTimeToLive() Get Maximum period in seconds before an unconsumed message expires, which is required if `policy` is 1.
Long	getMsgRetentionSeconds() Get The max period during which a message is retained before it is automatically acknowledged.
Long	getPolicy() Get Dead letter 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.
Tag[]	getTags() Get Tag array.
Boolean	getTrace() Get Whether to enable message trace.
Long	getTransaction() Get 1: transaction queue; 0: general queue
Long	getVisibilityTimeout() Get Message visibility timeout period.
void	setDeadLetterQueueName(String DeadLetterQueueName) Set Dead letter queue name
void	setFirstQueryInterval(Long FirstQueryInterval) Set First lookback interval
void	setMaxMsgHeapNum(Long MaxMsgHeapNum) Set Maximum number of heaped messages.
void	setMaxMsgSize(Long MaxMsgSize) Set Maximum message length.
void	setMaxQueryCount(Long MaxQueryCount) Set Maximum number of lookbacks
void	setMaxReceiveCount(Long MaxReceiveCount) Set Maximum receipt times.
void	setMaxTimeToLive(Long MaxTimeToLive) Set Maximum period in seconds before an unconsumed message expires, which is required if `policy` 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 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	setTags(Tag[] Tags) Set Tag array.
void	setTrace(Boolean Trace) Set Whether to enable message trace.
void	setTransaction(Long Transaction) Set 1: transaction queue; 0: general queue
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

CreateCmqQueueRequest

public CreateCmqQueueRequest()

CreateCmqQueueRequest

public CreateCmqQueueRequest(CreateCmqQueueRequest 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 Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536.

Returns:

MaxMsgSize Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536.

setMaxMsgSize

public void setMaxMsgSize(Long MaxMsgSize)

Set Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536.

Parameters:

MaxMsgSize - Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536.

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.

getTransaction

public Long getTransaction()

Get 1: transaction queue; 0: general queue

Returns:

Transaction 1: transaction queue; 0: general queue

setTransaction

public void setTransaction(Long Transaction)

Set 1: transaction queue; 0: general queue

Parameters:

Transaction - 1: transaction queue; 0: general queue

getFirstQueryInterval

public Long getFirstQueryInterval()

Get First lookback interval

Returns:

FirstQueryInterval First lookback interval

setFirstQueryInterval

public void setFirstQueryInterval(Long FirstQueryInterval)

Set First lookback interval

Parameters:

FirstQueryInterval - First lookback interval

getMaxQueryCount

public Long getMaxQueryCount()

Get Maximum number of lookbacks

Returns:

MaxQueryCount Maximum number of lookbacks

setMaxQueryCount

public void setMaxQueryCount(Long MaxQueryCount)

Set Maximum number of lookbacks

Parameters:

MaxQueryCount - Maximum number of lookbacks

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

getPolicy

public Long getPolicy()

Get Dead letter policy. 0: message has been consumed multiple times but not deleted; 1: `Time-To-Live` has elapsed

Returns:

Policy Dead letter policy. 0: message has been consumed multiple times but not deleted; 1: `Time-To-Live` has elapsed

setPolicy

public void setPolicy(Long Policy)

Set Dead letter policy. 0: message has been consumed multiple times but not deleted; 1: `Time-To-Live` has elapsed

Parameters:

Policy - Dead letter policy. 0: message has been consumed multiple times but not deleted; 1: `Time-To-Live` has elapsed

getMaxReceiveCount

public Long getMaxReceiveCount()

Get Maximum receipt times. Value range: 1–1000

Returns:

MaxReceiveCount Maximum receipt times. Value range: 1–1000

setMaxReceiveCount

public void setMaxReceiveCount(Long MaxReceiveCount)

Set Maximum receipt times. Value range: 1–1000

Parameters:

MaxReceiveCount - Maximum receipt times. Value range: 1–1000

getMaxTimeToLive

public Long getMaxTimeToLive()

Get Maximum period in seconds before an unconsumed message expires, which is required if `policy` 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 `policy` 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 `policy` 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 `policy` is 1. Value range: 300–43200. This value should be smaller than `msgRetentionSeconds` (maximum message retention period)

getTrace

public Boolean getTrace()

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

Returns:

Trace Whether to enable message trace. true: yes; false: no. If this field is not configured, 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 not configured, the feature will not be enabled

Parameters:

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

getTags

public Tag[] getTags()

Get Tag array.

Returns:

Tags Tag array.

setTags

public void setTags(Tag[] Tags)

Set Tag array.

Parameters:

Tags - Tag array.

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