com.tencentcloudapi.tdmq.v20200217.models

Class CmqTopic

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.CmqTopic

public class CmqTopic
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CmqTopic()
CmqTopic(CmqTopic 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
Long	getBrokerType() Get Valid values: `0` (Pulsar), `1` (RocketMQ).
Long	getCreateTime() Get Topic creation time.
Long	getCreateUin() Get Creator `Uin`.
Long	getFilterType() Get Filtering policy selected when a subscription is created: If `filterType` is 1, `FilterTag` will be used for filtering.
Long	getLastModifyTime() Get Time when the topic attribute is last modified.
Long	getMaxMsgSize() Get Maximum message size, which ranges from 1,024 to 1,048,576 bytes (i.e., 1–1,024 KB).
Long	getMsgCount() Get Number of current messages in the topic (number of retained messages).
Long	getMsgRetentionSeconds() Get Maximum lifecycle of message in topic.
String	getNamespaceName() Get Namespace name Note: this field may return null, indicating that no valid values can be obtained.
Long	getQps() Get Number of messages published per second.
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.
String	getTopicId() Get Topic ID.
String	getTopicName() Get Topic name.
Boolean	getTrace() Get Message trace.
void	setBrokerType(Long BrokerType) Set Valid values: `0` (Pulsar), `1` (RocketMQ).
void	setCreateTime(Long CreateTime) Set Topic creation time.
void	setCreateUin(Long CreateUin) Set Creator `Uin`.
void	setFilterType(Long FilterType) Set Filtering policy selected when a subscription is created: If `filterType` is 1, `FilterTag` will be used for filtering.
void	setLastModifyTime(Long LastModifyTime) Set Time when the topic attribute is last modified.
void	setMaxMsgSize(Long MaxMsgSize) Set Maximum message size, which ranges from 1,024 to 1,048,576 bytes (i.e., 1–1,024 KB).
void	setMsgCount(Long MsgCount) Set Number of current messages in the topic (number of retained messages).
void	setMsgRetentionSeconds(Long MsgRetentionSeconds) Set Maximum lifecycle of message in topic.
void	setNamespaceName(String NamespaceName) Set Namespace name Note: this field may return null, indicating that no valid values can be obtained.
void	setQps(Long Qps) Set Number of messages published per second.
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	setTopicId(String TopicId) Set Topic ID.
void	setTopicName(String TopicName) Set Topic name.
void	setTrace(Boolean Trace) Set Message trace.
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

CmqTopic

public CmqTopic()

CmqTopic

public CmqTopic(CmqTopic 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

getTopicId

public String getTopicId()

Get Topic ID. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

TopicId Topic ID. Note: this field may return null, indicating that no valid values can be obtained.

setTopicId

public void setTopicId(String TopicId)

Set Topic ID. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

TopicId - Topic ID. Note: this field may return null, indicating that no valid values can be obtained.

getTopicName

public String getTopicName()

Get Topic name. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

TopicName Topic name. Note: this field may return null, indicating that no valid values can be obtained.

setTopicName

public void setTopicName(String TopicName)

Set Topic name. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

TopicName - Topic name. Note: this field may return null, indicating that no valid values can be obtained.

getMsgRetentionSeconds

public Long getMsgRetentionSeconds()

Get Maximum lifecycle of message in topic. After the period specified by this parameter has elapsed since a message is sent to the topic, the message will be deleted no matter whether it has been successfully pushed to the user. This parameter is measured in seconds and defaulted to one day (86,400 seconds), which cannot be modified. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

MsgRetentionSeconds Maximum lifecycle of message in topic. After the period specified by this parameter has elapsed since a message is sent to the topic, the message will be deleted no matter whether it has been successfully pushed to the user. This parameter is measured in seconds and defaulted to one day (86,400 seconds), which cannot be modified. Note: this field may return null, indicating that no valid values can be obtained.

setMsgRetentionSeconds

public void setMsgRetentionSeconds(Long MsgRetentionSeconds)

Set Maximum lifecycle of message in topic. After the period specified by this parameter has elapsed since a message is sent to the topic, the message will be deleted no matter whether it has been successfully pushed to the user. This parameter is measured in seconds and defaulted to one day (86,400 seconds), which cannot be modified. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

MsgRetentionSeconds - Maximum lifecycle of message in topic. After the period specified by this parameter has elapsed since a message is sent to the topic, the message will be deleted no matter whether it has been successfully pushed to the user. This parameter is measured in seconds and defaulted to one day (86,400 seconds), which cannot be modified. Note: this field may return null, indicating that no valid values can be obtained.

getMaxMsgSize

public Long getMaxMsgSize()

Get Maximum message size, which ranges from 1,024 to 1,048,576 bytes (i.e., 1–1,024 KB). The default value is 65,536. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

MaxMsgSize Maximum message size, which ranges from 1,024 to 1,048,576 bytes (i.e., 1–1,024 KB). The default value is 65,536. Note: this field may return null, indicating that no valid values can be obtained.

setMaxMsgSize

public void setMaxMsgSize(Long MaxMsgSize)

Set Maximum message size, which ranges from 1,024 to 1,048,576 bytes (i.e., 1–1,024 KB). The default value is 65,536. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

MaxMsgSize - Maximum message size, which ranges from 1,024 to 1,048,576 bytes (i.e., 1–1,024 KB). The default value is 65,536. Note: this field may return null, indicating that no valid values can be obtained.

getQps

public Long getQps()

Get Number of messages published per second. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Qps Number of messages published per second. Note: this field may return null, indicating that no valid values can be obtained.

setQps

public void setQps(Long Qps)

Set Number of messages published per second. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Qps - Number of messages published per second. Note: this field may return null, indicating that no valid values can be obtained.

getFilterType

public Long getFilterType()

Get Filtering policy selected when a subscription is created: If `filterType` is 1, `FilterTag` will be used for filtering. If `filterType` is 2, `BindingKey` will be used for filtering. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

FilterType Filtering policy selected when a subscription is created: If `filterType` is 1, `FilterTag` will be used for filtering. If `filterType` is 2, `BindingKey` will be used for filtering. Note: this field may return null, indicating that no valid values can be obtained.

setFilterType

public void setFilterType(Long FilterType)

Set Filtering policy selected when a subscription is created: If `filterType` is 1, `FilterTag` will be used for filtering. If `filterType` is 2, `BindingKey` will be used for filtering. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

FilterType - Filtering policy selected when a subscription is created: If `filterType` is 1, `FilterTag` will be used for filtering. If `filterType` is 2, `BindingKey` will be used for filtering. Note: this field may return null, indicating that no valid values can be obtained.

getCreateTime

public Long getCreateTime()

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

Returns:

CreateTime Topic 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.

setCreateTime

public void setCreateTime(Long CreateTime)

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

Parameters:

CreateTime - Topic 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.

getLastModifyTime

public Long getLastModifyTime()

Get Time when the topic 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.

Returns:

LastModifyTime Time when the topic 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.

setLastModifyTime

public void setLastModifyTime(Long LastModifyTime)

Set Time when the topic 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.

Parameters:

LastModifyTime - Time when the topic 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.

getMsgCount

public Long getMsgCount()

Get Number of current messages in the topic (number of retained messages). Note: this field may return null, indicating that no valid values can be obtained.

Returns:

MsgCount Number of current messages in the topic (number of retained messages). Note: this field may return null, indicating that no valid values can be obtained.

setMsgCount

public void setMsgCount(Long MsgCount)

Set Number of current messages in the topic (number of retained messages). Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

MsgCount - Number of current messages in the topic (number of retained messages). Note: this field may return null, indicating that no valid values can be obtained.

getCreateUin

public Long getCreateUin()

Get Creator `Uin`. The `resource` field for CAM authentication is composed of this field. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

CreateUin Creator `Uin`. The `resource` field for CAM authentication is composed of this field. Note: this field may return null, indicating that no valid values can be obtained.

setCreateUin

public void setCreateUin(Long CreateUin)

Set Creator `Uin`. The `resource` field for CAM authentication is composed of this field. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

CreateUin - Creator `Uin`. The `resource` field for CAM authentication is composed of this field. Note: this field may return null, indicating that no valid values can be obtained.

getTags

public Tag[] getTags()

Get Associated tag. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Tags Associated tag. Note: this field may return null, indicating that no valid values can be obtained.

setTags

public void setTags(Tag[] Tags)

Set Associated tag. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Tags - Associated tag. Note: this field may return null, indicating that no valid values can be obtained.

getTrace

public Boolean getTrace()

Get Message trace. true: enabled; false: not enabled Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Trace Message trace. true: enabled; false: not enabled Note: this field may return null, indicating that no valid values can be obtained.

setTrace

public void setTrace(Boolean Trace)

Set Message trace. true: enabled; false: not enabled Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Trace - Message trace. true: enabled; false: not enabled Note: this field may return null, indicating that no valid values can be obtained.

getTenantId

public String getTenantId()

Get Tenant ID Note: this field may return null, indicating that no valid values can be obtained.

Returns:

TenantId Tenant ID Note: this field may return null, indicating that no valid values can be obtained.

setTenantId

public void setTenantId(String TenantId)

Set Tenant ID Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

TenantId - Tenant ID Note: this field may return null, indicating that no valid values can be obtained.

getNamespaceName

public String getNamespaceName()

Get Namespace name Note: this field may return null, indicating that no valid values can be obtained.

Returns:

NamespaceName Namespace name Note: this field may return null, indicating that no valid values can be obtained.

setNamespaceName

public void setNamespaceName(String NamespaceName)

Set Namespace name Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

NamespaceName - Namespace name Note: this field may return null, indicating that no valid values can be obtained.

getStatus

public Long getStatus()

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

Returns:

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.

setStatus

public void setStatus(Long Status)

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

Parameters:

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.

getBrokerType

public Long getBrokerType()

Get Valid values: `0` (Pulsar), `1` (RocketMQ). Note: This field may return null, indicating that no valid values can be obtained.

Returns:

BrokerType Valid values: `0` (Pulsar), `1` (RocketMQ). Note: This field may return null, indicating that no valid values can be obtained.

setBrokerType

public void setBrokerType(Long BrokerType)

Set Valid values: `0` (Pulsar), `1` (RocketMQ). Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

BrokerType - Valid values: `0` (Pulsar), `1` (RocketMQ). Note: This field may return null, indicating that no valid values can be obtained.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel