com.tencentcloudapi.tdmq.v20200217.models

Class Subscription

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.Subscription

public class Subscription
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
Subscription()
Subscription(Subscription 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
Boolean	getBlockedSubscriptionOnUnackedMsgs() Get Whether messages are blocked as the limit of unacknowledged messages has been reached.
String	getConnectedSince() Get The time when the consumer started connecting.
String	getConsumerAddr() Get Consumer address.
String	getConsumerCount() Get The number of consumers.
String	getConsumerName() Get Consumer name.
Consumer[]	getConsumerSets() Get Set of consumers.
ConsumersSchedule[]	getConsumersScheduleSets() Get Set of consumption progress information.
String	getCreateTime() Get Creation time.
String	getEnvironmentId() Get Environment (namespace) name.
Boolean	getIsOnline() Get Whether the consumer is online.
Long	getMaxUnackedMsgNum() Get The maximum number of unacknowledged messages.
String	getMsgBacklog() Get The number of heaped messages.
String	getMsgRateExpired() Get Percentage of messages under this subscription that were discarded but not sent after TTL.
String	getMsgRateOut() Get The total number of messages delivered by the consumer per second.
String	getMsgThroughputOut() Get The size (in bytes) of messages consumed by the consumer per second.
String	getRemark() Get Remarks.
String	getSubscriptionName() Get Subscription name.
String	getSubType() Get Subscription type.
String	getTopicName() Get Topic name.
String	getUpdateTime() Get Last modified.
void	setBlockedSubscriptionOnUnackedMsgs(Boolean BlockedSubscriptionOnUnackedMsgs) Set Whether messages are blocked as the limit of unacknowledged messages has been reached.
void	setConnectedSince(String ConnectedSince) Set The time when the consumer started connecting.
void	setConsumerAddr(String ConsumerAddr) Set Consumer address.
void	setConsumerCount(String ConsumerCount) Set The number of consumers.
void	setConsumerName(String ConsumerName) Set Consumer name.
void	setConsumerSets(Consumer[] ConsumerSets) Set Set of consumers.
void	setConsumersScheduleSets(ConsumersSchedule[] ConsumersScheduleSets) Set Set of consumption progress information.
void	setCreateTime(String CreateTime) Set Creation time.
void	setEnvironmentId(String EnvironmentId) Set Environment (namespace) name.
void	setIsOnline(Boolean IsOnline) Set Whether the consumer is online.
void	setMaxUnackedMsgNum(Long MaxUnackedMsgNum) Set The maximum number of unacknowledged messages.
void	setMsgBacklog(String MsgBacklog) Set The number of heaped messages.
void	setMsgRateExpired(String MsgRateExpired) Set Percentage of messages under this subscription that were discarded but not sent after TTL.
void	setMsgRateOut(String MsgRateOut) Set The total number of messages delivered by the consumer per second.
void	setMsgThroughputOut(String MsgThroughputOut) Set The size (in bytes) of messages consumed by the consumer per second.
void	setRemark(String Remark) Set Remarks.
void	setSubscriptionName(String SubscriptionName) Set Subscription name.
void	setSubType(String SubType) Set Subscription type.
void	setTopicName(String TopicName) Set Topic name.
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

Subscription

public Subscription()

Subscription

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

getTopicName

public String getTopicName()

Get Topic name.

Returns:

TopicName Topic name.

setTopicName

public void setTopicName(String TopicName)

Set Topic name.

Parameters:

TopicName - Topic name.

getEnvironmentId

public String getEnvironmentId()

Get Environment (namespace) name.

Returns:

EnvironmentId Environment (namespace) name.

setEnvironmentId

public void setEnvironmentId(String EnvironmentId)

Set Environment (namespace) name.

Parameters:

EnvironmentId - Environment (namespace) name.

getConnectedSince

public String getConnectedSince()

Get The time when the consumer started connecting. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

ConnectedSince The time when the consumer started connecting. Note: This field may return `null`, indicating that no valid values can be obtained.

setConnectedSince

public void setConnectedSince(String ConnectedSince)

Set The time when the consumer started connecting. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

ConnectedSince - The time when the consumer started connecting. Note: This field may return `null`, indicating that no valid values can be obtained.

getConsumerAddr

public String getConsumerAddr()

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

Returns:

ConsumerAddr Consumer address. Note: This field may return null, indicating that no valid values can be obtained.

setConsumerAddr

public void setConsumerAddr(String ConsumerAddr)

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

Parameters:

ConsumerAddr - Consumer address. 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.

getConsumerName

public String getConsumerName()

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

Returns:

ConsumerName Consumer name. Note: This field may return null, indicating that no valid values can be obtained.

setConsumerName

public void setConsumerName(String ConsumerName)

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

Parameters:

ConsumerName - Consumer name. Note: This field may return null, indicating that no valid values can be obtained.

getMsgBacklog

public String getMsgBacklog()

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

Returns:

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

setMsgBacklog

public void setMsgBacklog(String MsgBacklog)

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

Parameters:

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

getMsgRateExpired

public String getMsgRateExpired()

Get Percentage of messages under this subscription that were discarded but not sent after TTL. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MsgRateExpired Percentage of messages under this subscription that were discarded but not sent after TTL. Note: This field may return null, indicating that no valid values can be obtained.

setMsgRateExpired

public void setMsgRateExpired(String MsgRateExpired)

Set Percentage of messages under this subscription that were discarded but not sent after TTL. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MsgRateExpired - Percentage of messages under this subscription that were discarded but not sent after TTL. 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 the consumer 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 the consumer 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 the consumer 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 the consumer 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 consumed by the consumer per second. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MsgThroughputOut The size (in bytes) of messages consumed by the consumer 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 consumed by the consumer per second. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MsgThroughputOut - The size (in bytes) of messages consumed by the consumer per second. Note: This field may return null, indicating that no valid values can be obtained.

getSubscriptionName

public String getSubscriptionName()

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

Returns:

SubscriptionName Subscription name. Note: This field may return null, indicating that no valid values can be obtained.

setSubscriptionName

public void setSubscriptionName(String SubscriptionName)

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

Parameters:

SubscriptionName - Subscription name. Note: This field may return null, indicating that no valid values can be obtained.

getConsumerSets

public Consumer[] getConsumerSets()

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

Returns:

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

setConsumerSets

public void setConsumerSets(Consumer[] ConsumerSets)

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

Parameters:

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

getIsOnline

public Boolean getIsOnline()

Get Whether the consumer is online. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

IsOnline Whether the consumer is online. Note: This field may return null, indicating that no valid values can be obtained.

setIsOnline

public void setIsOnline(Boolean IsOnline)

Set Whether the consumer is online. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

IsOnline - Whether the consumer is online. Note: This field may return null, indicating that no valid values can be obtained.

getConsumersScheduleSets

public ConsumersSchedule[] getConsumersScheduleSets()

Get Set of consumption progress information. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ConsumersScheduleSets Set of consumption progress information. Note: This field may return null, indicating that no valid values can be obtained.

setConsumersScheduleSets

public void setConsumersScheduleSets(ConsumersSchedule[] ConsumersScheduleSets)

Set Set of consumption progress information. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ConsumersScheduleSets - Set of consumption progress information. Note: This field may return null, indicating that no valid values can be obtained.

getRemark

public String getRemark()

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

Returns:

Remark Remarks. Note: This field may return null, indicating that no valid values can be obtained.

setRemark

public void setRemark(String Remark)

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

Parameters:

Remark - Remarks. 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.

getSubType

public String getSubType()

Get Subscription type. Valid values: `Exclusive`, `Shared`, `Failover`, and `Key_Shared`. An empty string or `NULL`: Unknown. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

SubType Subscription type. Valid values: `Exclusive`, `Shared`, `Failover`, and `Key_Shared`. An empty string or `NULL`: Unknown. Note: This field may return null, indicating that no valid values can be obtained.

setSubType

public void setSubType(String SubType)

Set Subscription type. Valid values: `Exclusive`, `Shared`, `Failover`, and `Key_Shared`. An empty string or `NULL`: Unknown. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

SubType - Subscription type. Valid values: `Exclusive`, `Shared`, `Failover`, and `Key_Shared`. An empty string or `NULL`: Unknown. Note: This field may return null, indicating that no valid values can be obtained.

getBlockedSubscriptionOnUnackedMsgs

public Boolean getBlockedSubscriptionOnUnackedMsgs()

Get Whether messages are blocked as the limit of unacknowledged messages has been reached. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

BlockedSubscriptionOnUnackedMsgs Whether messages are blocked as the limit of unacknowledged messages has been reached. Note: This field may return null, indicating that no valid values can be obtained.

setBlockedSubscriptionOnUnackedMsgs

public void setBlockedSubscriptionOnUnackedMsgs(Boolean BlockedSubscriptionOnUnackedMsgs)

Set Whether messages are blocked as the limit of unacknowledged messages has been reached. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

BlockedSubscriptionOnUnackedMsgs - Whether messages are blocked as the limit of unacknowledged messages has been reached. Note: This field may return null, indicating that no valid values can be obtained.

getMaxUnackedMsgNum

public Long getMaxUnackedMsgNum()

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

Returns:

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

setMaxUnackedMsgNum

public void setMaxUnackedMsgNum(Long MaxUnackedMsgNum)

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

Parameters:

MaxUnackedMsgNum - The maximum number of unacknowledged messages. 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