Subscription (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.tdmq.v20200217.models.Subscription

public class Subscription
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getBlockedSubscriptionOnUnackedMsgs()` Get 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。
`String`	`getConnectedSince()` Get 消费者开始连接的时间。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getConsumerAddr()` Get 消费者地址。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getConsumerCount()` Get 消费者数量。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getConsumerName()` Get 消费者名称。注意：此字段可能返回 null，表示取不到有效值。
`Consumer[]`	`getConsumerSets()` Get 消费者集合。注意：此字段可能返回 null，表示取不到有效值。
`ConsumersSchedule[]`	`getConsumersScheduleSets()` Get 消费进度集合。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getCreateTime()` Get 创建时间。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getEnvironmentId()` Get 环境（命名空间）名称。
`Boolean`	`getIsOnline()` Get 是否在线。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getMaxUnackedMsgNum()` Get 未 ack 消息数上限注意：此字段可能返回 null，表示取不到有效值。
`String`	`getMsgBacklog()` Get 堆积的消息数量。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getMsgRateExpired()` Get 于TTL，此订阅下没有被发送而是被丢弃的比例。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getMsgRateOut()` Get 消费者每秒分发消息的数量之和。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getMsgThroughputOut()` Get 消费者每秒消息的byte。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getRemark()` Get 备注。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getSubscriptionName()` Get 订阅名称。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getSubType()` Get 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知，注意：此字段可能返回 null，表示取不到有效值。
`String`	`getTopicName()` Get 主题名称。
`String`	`getUpdateTime()` Get 最近修改时间。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setBlockedSubscriptionOnUnackedMsgs(Boolean BlockedSubscriptionOnUnackedMsgs)` Set 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。
`void`	`setConnectedSince(String ConnectedSince)` Set 消费者开始连接的时间。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setConsumerAddr(String ConsumerAddr)` Set 消费者地址。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setConsumerCount(String ConsumerCount)` Set 消费者数量。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setConsumerName(String ConsumerName)` Set 消费者名称。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setConsumerSets(Consumer[] ConsumerSets)` Set 消费者集合。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setConsumersScheduleSets(ConsumersSchedule[] ConsumersScheduleSets)` Set 消费进度集合。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setCreateTime(String CreateTime)` Set 创建时间。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setEnvironmentId(String EnvironmentId)` Set 环境（命名空间）名称。
`void`	`setIsOnline(Boolean IsOnline)` Set 是否在线。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setMaxUnackedMsgNum(Long MaxUnackedMsgNum)` Set 未 ack 消息数上限注意：此字段可能返回 null，表示取不到有效值。
`void`	`setMsgBacklog(String MsgBacklog)` Set 堆积的消息数量。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setMsgRateExpired(String MsgRateExpired)` Set 于TTL，此订阅下没有被发送而是被丢弃的比例。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setMsgRateOut(String MsgRateOut)` Set 消费者每秒分发消息的数量之和。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setMsgThroughputOut(String MsgThroughputOut)` Set 消费者每秒消息的byte。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setRemark(String Remark)` Set 备注。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setSubscriptionName(String SubscriptionName)` Set 订阅名称。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setSubType(String SubType)` Set 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知，注意：此字段可能返回 null，表示取不到有效值。
`void`	`setTopicName(String TopicName)` Set 主题名称。
`void`	`setUpdateTime(String UpdateTime)` Set 最近修改时间。注意：此字段可能返回 null，表示取不到有效值。
`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
  - 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 主题名称。
    
    Returns:
    
    TopicName 主题名称。
  - setTopicName
```
public void setTopicName(String TopicName)
```
    Set 主题名称。
    
    Parameters:
    
    TopicName - 主题名称。
  - getEnvironmentId
```
public String getEnvironmentId()
```
    Get 环境（命名空间）名称。
    
    Returns:
    
    EnvironmentId 环境（命名空间）名称。
  - setEnvironmentId
```
public void setEnvironmentId(String EnvironmentId)
```
    Set 环境（命名空间）名称。
    
    Parameters:
    
    EnvironmentId - 环境（命名空间）名称。
  - getConnectedSince
```
public String getConnectedSince()
```
    Get 消费者开始连接的时间。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ConnectedSince 消费者开始连接的时间。注意：此字段可能返回 null，表示取不到有效值。
  - setConnectedSince
```
public void setConnectedSince(String ConnectedSince)
```
    Set 消费者开始连接的时间。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ConnectedSince - 消费者开始连接的时间。注意：此字段可能返回 null，表示取不到有效值。
  - getConsumerAddr
```
public String getConsumerAddr()
```
    Get 消费者地址。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ConsumerAddr 消费者地址。注意：此字段可能返回 null，表示取不到有效值。
  - setConsumerAddr
```
public void setConsumerAddr(String ConsumerAddr)
```
    Set 消费者地址。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ConsumerAddr - 消费者地址。注意：此字段可能返回 null，表示取不到有效值。
  - getConsumerCount
```
public String getConsumerCount()
```
    Get 消费者数量。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ConsumerCount 消费者数量。注意：此字段可能返回 null，表示取不到有效值。
  - setConsumerCount
```
public void setConsumerCount(String ConsumerCount)
```
    Set 消费者数量。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ConsumerCount - 消费者数量。注意：此字段可能返回 null，表示取不到有效值。
  - getConsumerName
```
public String getConsumerName()
```
    Get 消费者名称。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ConsumerName 消费者名称。注意：此字段可能返回 null，表示取不到有效值。
  - setConsumerName
```
public void setConsumerName(String ConsumerName)
```
    Set 消费者名称。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ConsumerName - 消费者名称。注意：此字段可能返回 null，表示取不到有效值。
  - getMsgBacklog
```
public String getMsgBacklog()
```
    Get 堆积的消息数量。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    MsgBacklog 堆积的消息数量。注意：此字段可能返回 null，表示取不到有效值。
  - setMsgBacklog
```
public void setMsgBacklog(String MsgBacklog)
```
    Set 堆积的消息数量。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    MsgBacklog - 堆积的消息数量。注意：此字段可能返回 null，表示取不到有效值。
  - getMsgRateExpired
```
public String getMsgRateExpired()
```
    Get 于TTL，此订阅下没有被发送而是被丢弃的比例。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    MsgRateExpired 于TTL，此订阅下没有被发送而是被丢弃的比例。注意：此字段可能返回 null，表示取不到有效值。
  - setMsgRateExpired
```
public void setMsgRateExpired(String MsgRateExpired)
```
    Set 于TTL，此订阅下没有被发送而是被丢弃的比例。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    MsgRateExpired - 于TTL，此订阅下没有被发送而是被丢弃的比例。注意：此字段可能返回 null，表示取不到有效值。
  - getMsgRateOut
```
public String getMsgRateOut()
```
    Get 消费者每秒分发消息的数量之和。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    MsgRateOut 消费者每秒分发消息的数量之和。注意：此字段可能返回 null，表示取不到有效值。
  - setMsgRateOut
```
public void setMsgRateOut(String MsgRateOut)
```
    Set 消费者每秒分发消息的数量之和。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    MsgRateOut - 消费者每秒分发消息的数量之和。注意：此字段可能返回 null，表示取不到有效值。
  - getMsgThroughputOut
```
public String getMsgThroughputOut()
```
    Get 消费者每秒消息的byte。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    MsgThroughputOut 消费者每秒消息的byte。注意：此字段可能返回 null，表示取不到有效值。
  - setMsgThroughputOut
```
public void setMsgThroughputOut(String MsgThroughputOut)
```
    Set 消费者每秒消息的byte。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    MsgThroughputOut - 消费者每秒消息的byte。注意：此字段可能返回 null，表示取不到有效值。
  - getSubscriptionName
```
public String getSubscriptionName()
```
    Get 订阅名称。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    SubscriptionName 订阅名称。注意：此字段可能返回 null，表示取不到有效值。
  - setSubscriptionName
```
public void setSubscriptionName(String SubscriptionName)
```
    Set 订阅名称。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    SubscriptionName - 订阅名称。注意：此字段可能返回 null，表示取不到有效值。
  - getConsumerSets
```
public Consumer[] getConsumerSets()
```
    Get 消费者集合。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ConsumerSets 消费者集合。注意：此字段可能返回 null，表示取不到有效值。
  - setConsumerSets
```
public void setConsumerSets(Consumer[] ConsumerSets)
```
    Set 消费者集合。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ConsumerSets - 消费者集合。注意：此字段可能返回 null，表示取不到有效值。
  - getIsOnline
```
public Boolean getIsOnline()
```
    Get 是否在线。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    IsOnline 是否在线。注意：此字段可能返回 null，表示取不到有效值。
  - setIsOnline
```
public void setIsOnline(Boolean IsOnline)
```
    Set 是否在线。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    IsOnline - 是否在线。注意：此字段可能返回 null，表示取不到有效值。
  - getConsumersScheduleSets
```
public ConsumersSchedule[] getConsumersScheduleSets()
```
    Get 消费进度集合。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ConsumersScheduleSets 消费进度集合。注意：此字段可能返回 null，表示取不到有效值。
  - setConsumersScheduleSets
```
public void setConsumersScheduleSets(ConsumersSchedule[] ConsumersScheduleSets)
```
    Set 消费进度集合。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ConsumersScheduleSets - 消费进度集合。注意：此字段可能返回 null，表示取不到有效值。
  - getRemark
```
public String getRemark()
```
    Get 备注。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    Remark 备注。注意：此字段可能返回 null，表示取不到有效值。
  - setRemark
```
public void setRemark(String Remark)
```
    Set 备注。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    Remark - 备注。注意：此字段可能返回 null，表示取不到有效值。
  - getCreateTime
```
public String getCreateTime()
```
    Get 创建时间。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    CreateTime 创建时间。注意：此字段可能返回 null，表示取不到有效值。
  - setCreateTime
```
public void setCreateTime(String CreateTime)
```
    Set 创建时间。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    CreateTime - 创建时间。注意：此字段可能返回 null，表示取不到有效值。
  - getUpdateTime
```
public String getUpdateTime()
```
    Get 最近修改时间。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    UpdateTime 最近修改时间。注意：此字段可能返回 null，表示取不到有效值。
  - setUpdateTime
```
public void setUpdateTime(String UpdateTime)
```
    Set 最近修改时间。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    UpdateTime - 最近修改时间。注意：此字段可能返回 null，表示取不到有效值。
  - getSubType
```
public String getSubType()
```
    Get 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知，注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    SubType 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知，注意：此字段可能返回 null，表示取不到有效值。
  - setSubType
```
public void setSubType(String SubType)
```
    Set 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知，注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    SubType - 订阅类型，Exclusive，Shared，Failover， Key_Shared，空或NULL表示未知，注意：此字段可能返回 null，表示取不到有效值。
  - getBlockedSubscriptionOnUnackedMsgs
```
public Boolean getBlockedSubscriptionOnUnackedMsgs()
```
    Get 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    BlockedSubscriptionOnUnackedMsgs 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。
  - setBlockedSubscriptionOnUnackedMsgs
```
public void setBlockedSubscriptionOnUnackedMsgs(Boolean BlockedSubscriptionOnUnackedMsgs)
```
    Set 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    BlockedSubscriptionOnUnackedMsgs - 是否由于未 ack 数到达上限而被 block 注意：此字段可能返回 null，表示取不到有效值。
  - getMaxUnackedMsgNum
```
public Long getMaxUnackedMsgNum()
```
    Get 未 ack 消息数上限注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    MaxUnackedMsgNum 未 ack 消息数上限注意：此字段可能返回 null，表示取不到有效值。
  - setMaxUnackedMsgNum
```
public void setMaxUnackedMsgNum(Long MaxUnackedMsgNum)
```
    Set 未 ack 消息数上限注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    MaxUnackedMsgNum - 未 ack 消息数上限注意：此字段可能返回 null，表示取不到有效值。
  - 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.

Class Subscription

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

Subscription

Subscription

Method Detail

getTopicName

setTopicName

getEnvironmentId

setEnvironmentId

getConnectedSince

setConnectedSince

getConsumerAddr

setConsumerAddr

getConsumerCount

setConsumerCount

getConsumerName

setConsumerName

getMsgBacklog

setMsgBacklog

getMsgRateExpired

setMsgRateExpired

getMsgRateOut

setMsgRateOut

getMsgThroughputOut

setMsgThroughputOut

getSubscriptionName

setSubscriptionName

getConsumerSets

setConsumerSets

getIsOnline

setIsOnline

getConsumersScheduleSets

setConsumersScheduleSets

getRemark

setRemark

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

getSubType

setSubType

getBlockedSubscriptionOnUnackedMsgs

setBlockedSubscriptionOnUnackedMsgs

getMaxUnackedMsgNum

setMaxUnackedMsgNum

toMap