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

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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 死信队列名称
Long	getFirstQueryInterval() 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（即1-1024K），默认值 1048576。
Long	getMaxQueryCount() Get 最大回查次数
Long	getMaxReceiveCount() Get 最大接收次数 1-1000
Long	getMaxTimeToLive() Get policy为1时必选。最大未消费过期时间。范围300-43200，单位秒，需要小于消息最大保留时间msgRetentionSeconds
Long	getMsgRetentionSeconds() Get 消息最长未确认时间。取值范围 30-43200 秒（30秒~12小时），默认值 3600 (1 小时)。
Long	getPolicy() Get 死信策略。0为消息被多次消费未删除，1为Time-To-Live过期
Long	getPollingWaitSeconds() Get 消息接收长轮询等待时间。取值范围 0-30 秒，默认值 0。
String	getQueueName() Get 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
Long	getRetentionSizeInMB() Get 队列可回溯存储空间：若开启消息回溯，取值范围：10240MB - 512000MB，若不开启消息回溯，取值：0
Long	getRewindSeconds() Get 队列是否开启回溯消息能力，该参数取值范围0-1296000，0表示不开启。
Tag[]	getTags() Get 标签数组
Boolean	getTrace() Get 是否开启消息轨迹追踪，当不设置字段时，默认为不开启，该字段为true表示开启，为false表示不开启
Long	getTransaction() Get 1 表示事务队列，0 表示普通队列
Long	getVisibilityTimeout() Get 消息可见性超时。取值范围 1-43200 秒（即12小时内），默认值 30。
void	setDeadLetterQueueName(String DeadLetterQueueName) Set 死信队列名称
void	setFirstQueryInterval(Long FirstQueryInterval) 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（即1-1024K），默认值 1048576。
void	setMaxQueryCount(Long MaxQueryCount) Set 最大回查次数
void	setMaxReceiveCount(Long MaxReceiveCount) Set 最大接收次数 1-1000
void	setMaxTimeToLive(Long MaxTimeToLive) Set policy为1时必选。最大未消费过期时间。范围300-43200，单位秒，需要小于消息最大保留时间msgRetentionSeconds
void	setMsgRetentionSeconds(Long MsgRetentionSeconds) Set 消息最长未确认时间。取值范围 30-43200 秒（30秒~12小时），默认值 3600 (1 小时)。
void	setPolicy(Long Policy) Set 死信策略。0为消息被多次消费未删除，1为Time-To-Live过期
void	setPollingWaitSeconds(Long PollingWaitSeconds) Set 消息接收长轮询等待时间。取值范围 0-30 秒，默认值 0。
void	setQueueName(String QueueName) Set 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
void	setRetentionSizeInMB(Long RetentionSizeInMB) Set 队列可回溯存储空间：若开启消息回溯，取值范围：10240MB - 512000MB，若不开启消息回溯，取值：0
void	setRewindSeconds(Long RewindSeconds) Set 队列是否开启回溯消息能力，该参数取值范围0-1296000，0表示不开启。
void	setTags(Tag[] Tags) Set 标签数组
void	setTrace(Boolean Trace) Set 是否开启消息轨迹追踪，当不设置字段时，默认为不开启，该字段为true表示开启，为false表示不开启
void	setTransaction(Long Transaction) Set 1 表示事务队列，0 表示普通队列
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.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, 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 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。

Returns:

QueueName 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。

setQueueName

public void setQueueName(String QueueName)

Set 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。

Parameters:

QueueName - 队列名字，在单个地域同一账号下唯一。队列名称是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。

getMaxMsgHeapNum

public Long getMaxMsgHeapNum()

Get 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。

Returns:

MaxMsgHeapNum 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。

setMaxMsgHeapNum

public void setMaxMsgHeapNum(Long MaxMsgHeapNum)

Set 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。

Parameters:

MaxMsgHeapNum - 最大堆积消息数。取值范围在公测期间为 1,000,000 - 10,000,000，正式上线后范围可达到 1000,000-1000,000,000。默认取值在公测期间为 10,000,000，正式上线后为 100,000,000。

getPollingWaitSeconds

public Long getPollingWaitSeconds()

Get 消息接收长轮询等待时间。取值范围 0-30 秒，默认值 0。

Returns:

PollingWaitSeconds 消息接收长轮询等待时间。取值范围 0-30 秒，默认值 0。

setPollingWaitSeconds

public void setPollingWaitSeconds(Long PollingWaitSeconds)

Set 消息接收长轮询等待时间。取值范围 0-30 秒，默认值 0。

Parameters:

PollingWaitSeconds - 消息接收长轮询等待时间。取值范围 0-30 秒，默认值 0。

getVisibilityTimeout

public Long getVisibilityTimeout()

Get 消息可见性超时。取值范围 1-43200 秒（即12小时内），默认值 30。

Returns:

VisibilityTimeout 消息可见性超时。取值范围 1-43200 秒（即12小时内），默认值 30。

setVisibilityTimeout

public void setVisibilityTimeout(Long VisibilityTimeout)

Set 消息可见性超时。取值范围 1-43200 秒（即12小时内），默认值 30。

Parameters:

VisibilityTimeout - 消息可见性超时。取值范围 1-43200 秒（即12小时内），默认值 30。

getMaxMsgSize

public Long getMaxMsgSize()

Get 消息最大长度。取值范围 1024-1048576 Byte（即1-1024K），默认值 1048576。

Returns:

MaxMsgSize 消息最大长度。取值范围 1024-1048576 Byte（即1-1024K），默认值 1048576。

setMaxMsgSize

public void setMaxMsgSize(Long MaxMsgSize)

Set 消息最大长度。取值范围 1024-1048576 Byte（即1-1024K），默认值 1048576。

Parameters:

MaxMsgSize - 消息最大长度。取值范围 1024-1048576 Byte（即1-1024K），默认值 1048576。

getMsgRetentionSeconds

public Long getMsgRetentionSeconds()

Get 消息最长未确认时间。取值范围 30-43200 秒（30秒~12小时），默认值 3600 (1 小时)。

Returns:

MsgRetentionSeconds 消息最长未确认时间。取值范围 30-43200 秒（30秒~12小时），默认值 3600 (1 小时)。

setMsgRetentionSeconds

public void setMsgRetentionSeconds(Long MsgRetentionSeconds)

Set 消息最长未确认时间。取值范围 30-43200 秒（30秒~12小时），默认值 3600 (1 小时)。

Parameters:

MsgRetentionSeconds - 消息最长未确认时间。取值范围 30-43200 秒（30秒~12小时），默认值 3600 (1 小时)。

getRewindSeconds

public Long getRewindSeconds()

Get 队列是否开启回溯消息能力，该参数取值范围0-1296000，0表示不开启。

Returns:

RewindSeconds 队列是否开启回溯消息能力，该参数取值范围0-1296000，0表示不开启。

setRewindSeconds

public void setRewindSeconds(Long RewindSeconds)

Set 队列是否开启回溯消息能力，该参数取值范围0-1296000，0表示不开启。

Parameters:

RewindSeconds - 队列是否开启回溯消息能力，该参数取值范围0-1296000，0表示不开启。

getTransaction

public Long getTransaction()

Get 1 表示事务队列，0 表示普通队列

Returns:

Transaction 1 表示事务队列，0 表示普通队列

setTransaction

public void setTransaction(Long Transaction)

Set 1 表示事务队列，0 表示普通队列

Parameters:

Transaction - 1 表示事务队列，0 表示普通队列

getFirstQueryInterval

public Long getFirstQueryInterval()

Get 第一次回查间隔

Returns:

FirstQueryInterval 第一次回查间隔

setFirstQueryInterval

public void setFirstQueryInterval(Long FirstQueryInterval)

Set 第一次回查间隔

Parameters:

FirstQueryInterval - 第一次回查间隔

getMaxQueryCount

public Long getMaxQueryCount()

Get 最大回查次数

Returns:

MaxQueryCount 最大回查次数

setMaxQueryCount

public void setMaxQueryCount(Long MaxQueryCount)

Set 最大回查次数

Parameters:

MaxQueryCount - 最大回查次数

getDeadLetterQueueName

public String getDeadLetterQueueName()

Get 死信队列名称

Returns:

DeadLetterQueueName 死信队列名称

setDeadLetterQueueName

public void setDeadLetterQueueName(String DeadLetterQueueName)

Set 死信队列名称

Parameters:

DeadLetterQueueName - 死信队列名称

getPolicy

public Long getPolicy()

Get 死信策略。0为消息被多次消费未删除，1为Time-To-Live过期

Returns:

Policy 死信策略。0为消息被多次消费未删除，1为Time-To-Live过期

setPolicy

public void setPolicy(Long Policy)

Set 死信策略。0为消息被多次消费未删除，1为Time-To-Live过期

Parameters:

Policy - 死信策略。0为消息被多次消费未删除，1为Time-To-Live过期

getMaxReceiveCount

public Long getMaxReceiveCount()

Get 最大接收次数 1-1000

Returns:

MaxReceiveCount 最大接收次数 1-1000

setMaxReceiveCount

public void setMaxReceiveCount(Long MaxReceiveCount)

Set 最大接收次数 1-1000

Parameters:

MaxReceiveCount - 最大接收次数 1-1000

getMaxTimeToLive

public Long getMaxTimeToLive()

Get policy为1时必选。最大未消费过期时间。范围300-43200，单位秒，需要小于消息最大保留时间msgRetentionSeconds

Returns:

MaxTimeToLive policy为1时必选。最大未消费过期时间。范围300-43200，单位秒，需要小于消息最大保留时间msgRetentionSeconds

setMaxTimeToLive

public void setMaxTimeToLive(Long MaxTimeToLive)

Set policy为1时必选。最大未消费过期时间。范围300-43200，单位秒，需要小于消息最大保留时间msgRetentionSeconds

Parameters:

MaxTimeToLive - policy为1时必选。最大未消费过期时间。范围300-43200，单位秒，需要小于消息最大保留时间msgRetentionSeconds

getTrace

public Boolean getTrace()

Get 是否开启消息轨迹追踪，当不设置字段时，默认为不开启，该字段为true表示开启，为false表示不开启

Returns:

Trace 是否开启消息轨迹追踪，当不设置字段时，默认为不开启，该字段为true表示开启，为false表示不开启

setTrace

public void setTrace(Boolean Trace)

Set 是否开启消息轨迹追踪，当不设置字段时，默认为不开启，该字段为true表示开启，为false表示不开启

Parameters:

Trace - 是否开启消息轨迹追踪，当不设置字段时，默认为不开启，该字段为true表示开启，为false表示不开启

getTags

public Tag[] getTags()

Get 标签数组

Returns:

Tags 标签数组

setTags

public void setTags(Tag[] Tags)

Set 标签数组

Parameters:

Tags - 标签数组

getRetentionSizeInMB

public Long getRetentionSizeInMB()

Get 队列可回溯存储空间：若开启消息回溯，取值范围：10240MB - 512000MB，若不开启消息回溯，取值：0

Returns:

RetentionSizeInMB 队列可回溯存储空间：若开启消息回溯，取值范围：10240MB - 512000MB，若不开启消息回溯，取值：0

setRetentionSizeInMB

public void setRetentionSizeInMB(Long RetentionSizeInMB)

Set 队列可回溯存储空间：若开启消息回溯，取值范围：10240MB - 512000MB，若不开启消息回溯，取值：0

Parameters:

RetentionSizeInMB - 队列可回溯存储空间：若开启消息回溯，取值范围：10240MB - 512000MB，若不开启消息回溯，取值：0

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.