com.tencentcloudapi.tdmq.v20200217.models

Class Topic

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.Topic

public class Topic
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
Topic()
Topic(Topic 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	getAverageMsgSize() Get Average size of the messages published in the last interval in bytes.
String	getConsumerCount() Get The number of consumers.
String	getConsumerLimit() Get The maximum number of consumers.
String	getCreateTime() Get Creation time.
String	getEnvironmentId() Get Environment (namespace) name.
String	getLastConfirmedEntry() Get The total number of recorded messages.
String	getLastLedgerCreatedTimestamp() Get Time when the last ledger was created.
String	getMsgRateIn() Get The number of messages published by local and replicated publishers per second.
String	getMsgRateOut() Get The total number of messages delivered by local and replicated consumers per second.
String	getMsgThroughputIn() Get The size (in bytes) of messages published by local and replicated publishers per second.
String	getMsgThroughputOut() Get The size (in bytes) of messages delivered by local and replicated consumers per second.
String	getNumberOfEntries() Get The total number of recorded messages.
Long	getPartitions() Get Partition count ≤ 0: there are no subpartitions in the topic.
String	getProducerCount() Get The number of producers.
String	getProducerLimit() Get The maximum number of producers.
Long	getPulsarTopicType() Get `0`: Non-persistent and non-partitioned `1`: Non-persistent and partitioned `2`: Persistent and non-partitioned `3`: Persistent and partitioned Note: This field may return null, indicating that no valid values can be obtained.
String	getRemark() Get Remarks (up to 128 characters).
PartitionsTopic[]	getSubTopicSets() Get Subpartitions in a partitioned topic.
String	getTopicName() Get Topic name.
Long	getTopicType() Get Topic type description: 0: General message; 1: Globally sequential message; 2: Partitionally sequential message; 3: Retry letter topic; 4: Dead letter topic; 5: Transaction message.
String	getTotalSize() Get The size of all stored messages in bytes.
String	getUpdateTime() Get Last modified.
void	setAverageMsgSize(String AverageMsgSize) Set Average size of the messages published in the last interval in bytes.
void	setConsumerCount(String ConsumerCount) Set The number of consumers.
void	setConsumerLimit(String ConsumerLimit) Set The maximum number of consumers.
void	setCreateTime(String CreateTime) Set Creation time.
void	setEnvironmentId(String EnvironmentId) Set Environment (namespace) name.
void	setLastConfirmedEntry(String LastConfirmedEntry) Set The total number of recorded messages.
void	setLastLedgerCreatedTimestamp(String LastLedgerCreatedTimestamp) Set Time when the last ledger was created.
void	setMsgRateIn(String MsgRateIn) Set The number of messages published by local and replicated publishers per second.
void	setMsgRateOut(String MsgRateOut) Set The total number of messages delivered by local and replicated consumers per second.
void	setMsgThroughputIn(String MsgThroughputIn) Set The size (in bytes) of messages published by local and replicated publishers per second.
void	setMsgThroughputOut(String MsgThroughputOut) Set The size (in bytes) of messages delivered by local and replicated consumers per second.
void	setNumberOfEntries(String NumberOfEntries) Set The total number of recorded messages.
void	setPartitions(Long Partitions) Set Partition count ≤ 0: there are no subpartitions in the topic.
void	setProducerCount(String ProducerCount) Set The number of producers.
void	setProducerLimit(String ProducerLimit) Set The maximum number of producers.
void	setPulsarTopicType(Long PulsarTopicType) Set `0`: Non-persistent and non-partitioned `1`: Non-persistent and partitioned `2`: Persistent and non-partitioned `3`: Persistent and partitioned Note: This field may return null, indicating that no valid values can be obtained.
void	setRemark(String Remark) Set Remarks (up to 128 characters).
void	setSubTopicSets(PartitionsTopic[] SubTopicSets) Set Subpartitions in a partitioned topic.
void	setTopicName(String TopicName) Set Topic name.
void	setTopicType(Long TopicType) Set Topic type description: 0: General message; 1: Globally sequential message; 2: Partitionally sequential message; 3: Retry letter topic; 4: Dead letter topic; 5: Transaction message.
void	setTotalSize(String TotalSize) Set The size of all stored messages in bytes.
void	setUpdateTime(String UpdateTime) Set Last modified.
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

Topic

public Topic()

Topic

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

getAverageMsgSize

public String getAverageMsgSize()

Get Average size of the messages published in the last interval in bytes. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

AverageMsgSize Average size of the messages published in the last interval in bytes. Note: This field may return `null`, indicating that no valid values can be obtained.

setAverageMsgSize

public void setAverageMsgSize(String AverageMsgSize)

Set Average size of the messages published in the last interval in bytes. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

AverageMsgSize - Average size of the messages published in the last interval in bytes. Note: This field may return `null`, indicating that no valid values can be obtained.

getConsumerCount

public String getConsumerCount()

Get The number of consumers. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ConsumerCount The number of consumers. Note: This field may return null, indicating that no valid values can be obtained.

setConsumerCount

public void setConsumerCount(String ConsumerCount)

Set The number of consumers. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ConsumerCount - The number of consumers. Note: This field may return null, indicating that no valid values can be obtained.

getLastConfirmedEntry

public String getLastConfirmedEntry()

Get The total number of recorded messages. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

LastConfirmedEntry The total number of recorded messages. Note: This field may return null, indicating that no valid values can be obtained.

setLastConfirmedEntry

public void setLastConfirmedEntry(String LastConfirmedEntry)

Set The total number of recorded messages. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

LastConfirmedEntry - The total number of recorded messages. Note: This field may return null, indicating that no valid values can be obtained.

getLastLedgerCreatedTimestamp

public String getLastLedgerCreatedTimestamp()

Get Time when the last ledger was created. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

LastLedgerCreatedTimestamp Time when the last ledger was created. Note: This field may return null, indicating that no valid values can be obtained.

setLastLedgerCreatedTimestamp

public void setLastLedgerCreatedTimestamp(String LastLedgerCreatedTimestamp)

Set Time when the last ledger was created. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

LastLedgerCreatedTimestamp - Time when the last ledger was created. Note: This field may return null, indicating that no valid values can be obtained.

getMsgRateIn

public String getMsgRateIn()

Get The number of messages published by local and replicated publishers per second. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MsgRateIn The number of messages published by local and replicated publishers per second. Note: This field may return null, indicating that no valid values can be obtained.

setMsgRateIn

public void setMsgRateIn(String MsgRateIn)

Set The number of messages published by local and replicated publishers per second. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MsgRateIn - The number of messages published by local and replicated publishers per second. Note: This field may return null, indicating that no valid values can be obtained.

getMsgRateOut

public String getMsgRateOut()

Get The total number of messages delivered by local and replicated consumers per second. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MsgRateOut The total number of messages delivered by local and replicated consumers per second. Note: This field may return null, indicating that no valid values can be obtained.

setMsgRateOut

public void setMsgRateOut(String MsgRateOut)

Set The total number of messages delivered by local and replicated consumers per second. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MsgRateOut - The total number of messages delivered by local and replicated consumers per second. Note: This field may return null, indicating that no valid values can be obtained.

getMsgThroughputIn

public String getMsgThroughputIn()

Get The size (in bytes) of messages published by local and replicated publishers per second. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MsgThroughputIn The size (in bytes) of messages published by local and replicated publishers per second. Note: This field may return null, indicating that no valid values can be obtained.

setMsgThroughputIn

public void setMsgThroughputIn(String MsgThroughputIn)

Set The size (in bytes) of messages published by local and replicated publishers per second. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MsgThroughputIn - The size (in bytes) of messages published by local and replicated publishers per second. Note: This field may return null, indicating that no valid values can be obtained.

getMsgThroughputOut

public String getMsgThroughputOut()

Get The size (in bytes) of messages delivered by local and replicated consumers per second. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MsgThroughputOut The size (in bytes) of messages delivered by local and replicated consumers per second. Note: This field may return null, indicating that no valid values can be obtained.

setMsgThroughputOut

public void setMsgThroughputOut(String MsgThroughputOut)

Set The size (in bytes) of messages delivered by local and replicated consumers per second. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MsgThroughputOut - The size (in bytes) of messages delivered by local and replicated consumers per second. Note: This field may return null, indicating that no valid values can be obtained.

getNumberOfEntries

public String getNumberOfEntries()

Get The total number of recorded messages. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

NumberOfEntries The total number of recorded messages. Note: This field may return null, indicating that no valid values can be obtained.

setNumberOfEntries

public void setNumberOfEntries(String NumberOfEntries)

Set The total number of recorded messages. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

NumberOfEntries - The total number of recorded messages. Note: This field may return null, indicating that no valid values can be obtained.

getPartitions

public Long getPartitions()

Get Partition count ≤ 0: there are no subpartitions in the topic. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Partitions Partition count ≤ 0: there are no subpartitions in the topic. Note: This field may return null, indicating that no valid values can be obtained.

setPartitions

public void setPartitions(Long Partitions)

Set Partition count ≤ 0: there are no subpartitions in the topic. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Partitions - Partition count ≤ 0: there are no subpartitions in the topic. Note: This field may return null, indicating that no valid values can be obtained.

getProducerCount

public String getProducerCount()

Get The number of producers. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ProducerCount The number of producers. Note: This field may return null, indicating that no valid values can be obtained.

setProducerCount

public void setProducerCount(String ProducerCount)

Set The number of producers. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ProducerCount - The number of producers. Note: This field may return null, indicating that no valid values can be obtained.

getTotalSize

public String getTotalSize()

Get The size of all stored messages in bytes. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

TotalSize The size of all stored messages in bytes. Note: This field may return null, indicating that no valid values can be obtained.

setTotalSize

public void setTotalSize(String TotalSize)

Set The size of all stored messages in bytes. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

TotalSize - The size of all stored messages in bytes. Note: This field may return null, indicating that no valid values can be obtained.

getSubTopicSets

public PartitionsTopic[] getSubTopicSets()

Get Subpartitions in a partitioned topic. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

SubTopicSets Subpartitions in a partitioned topic. Note: This field may return null, indicating that no valid values can be obtained.

setSubTopicSets

public void setSubTopicSets(PartitionsTopic[] SubTopicSets)

Set Subpartitions in a partitioned topic. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

SubTopicSets - Subpartitions in a partitioned topic. Note: This field may return null, indicating that no valid values can be obtained.

getTopicType

public Long getTopicType()

Get Topic type description: 0: General message; 1: Globally sequential message; 2: Partitionally sequential message; 3: Retry letter topic; 4: Dead letter topic; 5: Transaction message. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

TopicType Topic type description: 0: General message; 1: Globally sequential message; 2: Partitionally sequential message; 3: Retry letter topic; 4: Dead letter topic; 5: Transaction message. Note: This field may return null, indicating that no valid values can be obtained.

setTopicType

public void setTopicType(Long TopicType)

Set Topic type description: 0: General message; 1: Globally sequential message; 2: Partitionally sequential message; 3: Retry letter topic; 4: Dead letter topic; 5: Transaction message. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

TopicType - Topic type description: 0: General message; 1: Globally sequential message; 2: Partitionally sequential message; 3: Retry letter topic; 4: Dead letter topic; 5: Transaction message. Note: This field may return null, indicating that no valid values can be obtained.

getEnvironmentId

public String getEnvironmentId()

Get Environment (namespace) name. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

EnvironmentId Environment (namespace) name. Note: This field may return null, indicating that no valid values can be obtained.

setEnvironmentId

public void setEnvironmentId(String EnvironmentId)

Set Environment (namespace) name. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

EnvironmentId - Environment (namespace) name. 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.

getRemark

public String getRemark()

Get Remarks (up to 128 characters). Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Remark Remarks (up to 128 characters). Note: This field may return null, indicating that no valid values can be obtained.

setRemark

public void setRemark(String Remark)

Set Remarks (up to 128 characters). Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Remark - Remarks (up to 128 characters). Note: This field may return null, indicating that no valid values can be obtained.

getCreateTime

public String getCreateTime()

Get Creation time. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

CreateTime Creation time. Note: This field may return null, indicating that no valid values can be obtained.

setCreateTime

public void setCreateTime(String CreateTime)

Set Creation time. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

CreateTime - Creation time. Note: This field may return null, indicating that no valid values can be obtained.

getUpdateTime

public String getUpdateTime()

Get Last modified. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

UpdateTime Last modified. Note: This field may return null, indicating that no valid values can be obtained.

setUpdateTime

public void setUpdateTime(String UpdateTime)

Set Last modified. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

UpdateTime - Last modified. Note: This field may return null, indicating that no valid values can be obtained.

getProducerLimit

public String getProducerLimit()

Get The maximum number of producers. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ProducerLimit The maximum number of producers. Note: This field may return null, indicating that no valid values can be obtained.

setProducerLimit

public void setProducerLimit(String ProducerLimit)

Set The maximum number of producers. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ProducerLimit - The maximum number of producers. Note: This field may return null, indicating that no valid values can be obtained.

getConsumerLimit

public String getConsumerLimit()

Get The maximum number of consumers. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ConsumerLimit The maximum number of consumers. Note: This field may return null, indicating that no valid values can be obtained.

setConsumerLimit

public void setConsumerLimit(String ConsumerLimit)

Set The maximum number of consumers. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ConsumerLimit - The maximum number of consumers. Note: This field may return null, indicating that no valid values can be obtained.

getPulsarTopicType

public Long getPulsarTopicType()

Get `0`: Non-persistent and non-partitioned `1`: Non-persistent and partitioned `2`: Persistent and non-partitioned `3`: Persistent and partitioned Note: This field may return null, indicating that no valid values can be obtained.

Returns:

PulsarTopicType `0`: Non-persistent and non-partitioned `1`: Non-persistent and partitioned `2`: Persistent and non-partitioned `3`: Persistent and partitioned Note: This field may return null, indicating that no valid values can be obtained.

setPulsarTopicType

public void setPulsarTopicType(Long PulsarTopicType)

Set `0`: Non-persistent and non-partitioned `1`: Non-persistent and partitioned `2`: Persistent and non-partitioned `3`: Persistent and partitioned Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

PulsarTopicType - `0`: Non-persistent and non-partitioned `1`: Non-persistent and partitioned `2`: Persistent and non-partitioned `3`: Persistent and partitioned 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