CmqSubscription (tencentcloud-sdk-java 3.1.1355 API)

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

public class CmqSubscription
extends AbstractModel

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

Constructor Summary

Constructors
Constructor and Description
`CmqSubscription()`
`CmqSubscription(CmqSubscription 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
`String[]`	`getBindingKey()` Get 表示订阅接收消息的过滤策略。注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getCreateTime()` Get 订阅的创建时间。返回 Unix 时间戳，精确到毫秒。
`String`	`getEndpoint()` Get 接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以http://开头，host 可以是域名或 IP；对于 queue，则填 queueName。
`String[]`	`getFilterTags()` Get 描述用户创建订阅时选择的过滤策略： filterType = 1表示用户使用 filterTag 标签过滤 filterType = 2表示用户使用 bindingKey 过滤。
`Long`	`getLastModifyTime()` Get 最后一次修改订阅属性的时间。返回 Unix 时间戳，精确到毫秒。
`Long`	`getMsgCount()` Get 该订阅待投递的消息数。
`String`	`getNotifyContentFormat()` Get 推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 protocol 是 queue，则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP，两个值均可以，默认值是 JSON。
`String`	`getNotifyStrategy()` Get 向 endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值有：（1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；（2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始 1s，后面是 2s，4s，8s...由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。
`String`	`getProtocol()` Get 订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。
`String`	`getSubscriptionId()` Get 订阅 ID。订阅 ID 在拉取监控数据时会用到。
`String`	`getSubscriptionName()` Get 订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
`String`	`getTopicName()` Get 订阅所属的主题名称
`Long`	`getTopicOwner()` Get 订阅拥有者的 APPID。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setBindingKey(String[] BindingKey)` Set 表示订阅接收消息的过滤策略。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setCreateTime(Long CreateTime)` Set 订阅的创建时间。返回 Unix 时间戳，精确到毫秒。
`void`	`setEndpoint(String Endpoint)` Set 接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以http://开头，host 可以是域名或 IP；对于 queue，则填 queueName。
`void`	`setFilterTags(String[] FilterTags)` Set 描述用户创建订阅时选择的过滤策略： filterType = 1表示用户使用 filterTag 标签过滤 filterType = 2表示用户使用 bindingKey 过滤。
`void`	`setLastModifyTime(Long LastModifyTime)` Set 最后一次修改订阅属性的时间。返回 Unix 时间戳，精确到毫秒。
`void`	`setMsgCount(Long MsgCount)` Set 该订阅待投递的消息数。
`void`	`setNotifyContentFormat(String NotifyContentFormat)` Set 推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 protocol 是 queue，则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP，两个值均可以，默认值是 JSON。
`void`	`setNotifyStrategy(String NotifyStrategy)` Set 向 endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值有：（1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；（2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始 1s，后面是 2s，4s，8s...由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。
`void`	`setProtocol(String Protocol)` Set 订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。
`void`	`setSubscriptionId(String SubscriptionId)` Set 订阅 ID。订阅 ID 在拉取监控数据时会用到。
`void`	`setSubscriptionName(String SubscriptionName)` Set 订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
`void`	`setTopicName(String TopicName)` Set 订阅所属的主题名称
`void`	`setTopicOwner(Long TopicOwner)` Set 订阅拥有者的 APPID。注意：此字段可能返回 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
  - CmqSubscription
```
public CmqSubscription()
```
  - CmqSubscription
```
public CmqSubscription(CmqSubscription 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
  - getSubscriptionName
```
public String getSubscriptionName()
```
    Get 订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
    
    Returns:
    
    SubscriptionName 订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
  - setSubscriptionName
```
public void setSubscriptionName(String SubscriptionName)
```
    Set 订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
    
    Parameters:
    
    SubscriptionName - 订阅名字，在单个地域同一账号的同一主题下唯一。订阅名称是一个不超过64个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)。
  - getSubscriptionId
```
public String getSubscriptionId()
```
    Get 订阅 ID。订阅 ID 在拉取监控数据时会用到。
    
    Returns:
    
    SubscriptionId 订阅 ID。订阅 ID 在拉取监控数据时会用到。
  - setSubscriptionId
```
public void setSubscriptionId(String SubscriptionId)
```
    Set 订阅 ID。订阅 ID 在拉取监控数据时会用到。
    
    Parameters:
    
    SubscriptionId - 订阅 ID。订阅 ID 在拉取监控数据时会用到。
  - getTopicOwner
```
public Long getTopicOwner()
```
    Get 订阅拥有者的 APPID。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    TopicOwner 订阅拥有者的 APPID。注意：此字段可能返回 null，表示取不到有效值。
  - setTopicOwner
```
public void setTopicOwner(Long TopicOwner)
```
    Set 订阅拥有者的 APPID。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    TopicOwner - 订阅拥有者的 APPID。注意：此字段可能返回 null，表示取不到有效值。
  - getMsgCount
```
public Long getMsgCount()
```
    Get 该订阅待投递的消息数。
    
    Returns:
    
    MsgCount 该订阅待投递的消息数。
  - setMsgCount
```
public void setMsgCount(Long MsgCount)
```
    Set 该订阅待投递的消息数。
    
    Parameters:
    
    MsgCount - 该订阅待投递的消息数。
  - getLastModifyTime
```
public Long getLastModifyTime()
```
    Get 最后一次修改订阅属性的时间。返回 Unix 时间戳，精确到毫秒。
    
    Returns:
    
    LastModifyTime 最后一次修改订阅属性的时间。返回 Unix 时间戳，精确到毫秒。
  - setLastModifyTime
```
public void setLastModifyTime(Long LastModifyTime)
```
    Set 最后一次修改订阅属性的时间。返回 Unix 时间戳，精确到毫秒。
    
    Parameters:
    
    LastModifyTime - 最后一次修改订阅属性的时间。返回 Unix 时间戳，精确到毫秒。
  - getCreateTime
```
public Long getCreateTime()
```
    Get 订阅的创建时间。返回 Unix 时间戳，精确到毫秒。
    
    Returns:
    
    CreateTime 订阅的创建时间。返回 Unix 时间戳，精确到毫秒。
  - setCreateTime
```
public void setCreateTime(Long CreateTime)
```
    Set 订阅的创建时间。返回 Unix 时间戳，精确到毫秒。
    
    Parameters:
    
    CreateTime - 订阅的创建时间。返回 Unix 时间戳，精确到毫秒。
  - getBindingKey
```
public String[] getBindingKey()
```
    Get 表示订阅接收消息的过滤策略。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    BindingKey 表示订阅接收消息的过滤策略。注意：此字段可能返回 null，表示取不到有效值。
  - setBindingKey
```
public void setBindingKey(String[] BindingKey)
```
    Set 表示订阅接收消息的过滤策略。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    BindingKey - 表示订阅接收消息的过滤策略。注意：此字段可能返回 null，表示取不到有效值。
  - getEndpoint
```
public String getEndpoint()
```
    Get 接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以http://开头，host 可以是域名或 IP；对于 queue，则填 queueName。
    
    Returns:
    
    Endpoint 接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以http://开头，host 可以是域名或 IP；对于 queue，则填 queueName。
  - setEndpoint
```
public void setEndpoint(String Endpoint)
```
    Set 接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以http://开头，host 可以是域名或 IP；对于 queue，则填 queueName。
    
    Parameters:
    
    Endpoint - 接收通知的 endpoint，根据协议 protocol 区分：对于 HTTP，endpoint 必须以http://开头，host 可以是域名或 IP；对于 queue，则填 queueName。
  - getFilterTags
```
public String[] getFilterTags()
```
    Get 描述用户创建订阅时选择的过滤策略： filterType = 1表示用户使用 filterTag 标签过滤 filterType = 2表示用户使用 bindingKey 过滤。
    
    Returns:
    
    FilterTags 描述用户创建订阅时选择的过滤策略： filterType = 1表示用户使用 filterTag 标签过滤 filterType = 2表示用户使用 bindingKey 过滤。
  - setFilterTags
```
public void setFilterTags(String[] FilterTags)
```
    Set 描述用户创建订阅时选择的过滤策略： filterType = 1表示用户使用 filterTag 标签过滤 filterType = 2表示用户使用 bindingKey 过滤。
    
    Parameters:
    
    FilterTags - 描述用户创建订阅时选择的过滤策略： filterType = 1表示用户使用 filterTag 标签过滤 filterType = 2表示用户使用 bindingKey 过滤。
  - getProtocol
```
public String getProtocol()
```
    Get 订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。
    
    Returns:
    
    Protocol 订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。
  - setProtocol
```
public void setProtocol(String Protocol)
```
    Set 订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。
    
    Parameters:
    
    Protocol - 订阅的协议，目前支持两种协议：HTTP、queue。使用 HTTP 协议，用户需自己搭建接受消息的 Web Server。使用 queue，消息会自动推送到 CMQ queue，用户可以并发地拉取消息。
  - getNotifyStrategy
```
public String getNotifyStrategy()
```
    Get 向 endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值有：（1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；（2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始 1s，后面是 2s，4s，8s...由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。
    
    Returns:
    
    NotifyStrategy 向 endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值有：（1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；（2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始 1s，后面是 2s，4s，8s...由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。
  - setNotifyStrategy
```
public void setNotifyStrategy(String NotifyStrategy)
```
    Set 向 endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值有：（1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；（2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始 1s，后面是 2s，4s，8s...由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。
    
    Parameters:
    
    NotifyStrategy - 向 endpoint 推送消息出现错误时，CMQ 推送服务器的重试策略。取值有：（1）BACKOFF_RETRY，退避重试。每隔一定时间重试一次，重试够一定次数后，就把该消息丢弃，继续推送下一条消息；（2）EXPONENTIAL_DECAY_RETRY，指数衰退重试。每次重试的间隔是指数递增的，例如开始 1s，后面是 2s，4s，8s...由于 Topic 消息的周期是一天，所以最多重试一天就把消息丢弃。默认值是 EXPONENTIAL_DECAY_RETRY。
  - getNotifyContentFormat
```
public String getNotifyContentFormat()
```
    Get 推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 protocol 是 queue，则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP，两个值均可以，默认值是 JSON。
    
    Returns:
    
    NotifyContentFormat 推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 protocol 是 queue，则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP，两个值均可以，默认值是 JSON。
  - setNotifyContentFormat
```
public void setNotifyContentFormat(String NotifyContentFormat)
```
    Set 推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 protocol 是 queue，则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP，两个值均可以，默认值是 JSON。
    
    Parameters:
    
    NotifyContentFormat - 推送内容的格式。取值：（1）JSON；（2）SIMPLIFIED，即 raw 格式。如果 protocol 是 queue，则取值必须为 SIMPLIFIED。如果 protocol 是 HTTP，两个值均可以，默认值是 JSON。
  - getTopicName
```
public String getTopicName()
```
    Get 订阅所属的主题名称
    
    Returns:
    
    TopicName 订阅所属的主题名称
  - setTopicName
```
public void setTopicName(String TopicName)
```
    Set 订阅所属的主题名称
    
    Parameters:
    
    TopicName - 订阅所属的主题名称
  - 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 CmqSubscription

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

CmqSubscription

CmqSubscription

Method Detail

getSubscriptionName

setSubscriptionName

getSubscriptionId

setSubscriptionId

getTopicOwner

setTopicOwner

getMsgCount

setMsgCount

getLastModifyTime

setLastModifyTime

getCreateTime

setCreateTime

getBindingKey

setBindingKey

getEndpoint

setEndpoint

getFilterTags

setFilterTags

getProtocol

setProtocol

getNotifyStrategy

setNotifyStrategy

getNotifyContentFormat

setNotifyContentFormat

getTopicName

setTopicName

toMap