com.tencentcloudapi.tdmq.v20200217.models

Class CmqSubscription

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tdmq.v20200217.models.CmqSubscription

public class CmqSubscription
extends AbstractModel

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

Modifier and Type	Method and Description
String[]	getBindingKey() Get Filtering policy for subscribing to and receiving messages.
Long	getCreateTime() Get Subscription creation time.
String	getEndpoint() Get Endpoint that receives notifications, which varies by `protocol`: for HTTP, the endpoint must start with `http://`, and the `host` can be a domain or IP; for `queue`, `queueName` should be entered.
String[]	getFilterTags() 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 subscription attribute is last modified.
Long	getMsgCount() Get Number of messages to be delivered in the subscription.
String	getNotifyContentFormat() Get Push content format.
String	getNotifyStrategy() Get CMQ push server retry policy in case an error occurs while pushing a message to the endpoint.
String	getProtocol() Get Subscription protocol.
String	getSubscriptionId() Get Subscription ID, which will be used during monitoring data pull.
String	getSubscriptionName() Get Subscription name, which must be unique in the same topic under the same account in the same region.
Long	getTopicOwner() Get Subscription owner `APPID`.
void	setBindingKey(String[] BindingKey) Set Filtering policy for subscribing to and receiving messages.
void	setCreateTime(Long CreateTime) Set Subscription creation time.
void	setEndpoint(String Endpoint) Set Endpoint that receives notifications, which varies by `protocol`: for HTTP, the endpoint must start with `http://`, and the `host` can be a domain or IP; for `queue`, `queueName` should be entered.
void	setFilterTags(String[] FilterTags) 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 subscription attribute is last modified.
void	setMsgCount(Long MsgCount) Set Number of messages to be delivered in the subscription.
void	setNotifyContentFormat(String NotifyContentFormat) Set Push content format.
void	setNotifyStrategy(String NotifyStrategy) Set CMQ push server retry policy in case an error occurs while pushing a message to the endpoint.
void	setProtocol(String Protocol) Set Subscription protocol.
void	setSubscriptionId(String SubscriptionId) Set Subscription ID, which will be used during monitoring data pull.
void	setSubscriptionName(String SubscriptionName) Set Subscription name, which must be unique in the same topic under the same account in the same region.
void	setTopicOwner(Long TopicOwner) Set Subscription owner `APPID`.
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

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 Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

SubscriptionName Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. Note: this field may return null, indicating that no valid values can be obtained.

setSubscriptionName

public void setSubscriptionName(String SubscriptionName)

Set Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

SubscriptionName - Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter. Note: this field may return null, indicating that no valid values can be obtained.

getSubscriptionId

public String getSubscriptionId()

Get Subscription ID, which will be used during monitoring data pull. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

SubscriptionId Subscription ID, which will be used during monitoring data pull. Note: this field may return null, indicating that no valid values can be obtained.

setSubscriptionId

public void setSubscriptionId(String SubscriptionId)

Set Subscription ID, which will be used during monitoring data pull. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

SubscriptionId - Subscription ID, which will be used during monitoring data pull. Note: this field may return null, indicating that no valid values can be obtained.

getTopicOwner

public Long getTopicOwner()

Get Subscription owner `APPID`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

TopicOwner Subscription owner `APPID`. Note: this field may return null, indicating that no valid values can be obtained.

setTopicOwner

public void setTopicOwner(Long TopicOwner)

Set Subscription owner `APPID`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

TopicOwner - Subscription owner `APPID`. Note: this field may return null, indicating that no valid values can be obtained.

getMsgCount

public Long getMsgCount()

Get Number of messages to be delivered in the subscription. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

MsgCount Number of messages to be delivered in the subscription. Note: this field may return null, indicating that no valid values can be obtained.

setMsgCount

public void setMsgCount(Long MsgCount)

Set Number of messages to be delivered in the subscription. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

MsgCount - Number of messages to be delivered in the subscription. Note: this field may return null, indicating that no valid values can be obtained.

getLastModifyTime

public Long getLastModifyTime()

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

getCreateTime

public Long getCreateTime()

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

getBindingKey

public String[] getBindingKey()

Get Filtering policy for subscribing to and receiving messages. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

BindingKey Filtering policy for subscribing to and receiving messages. Note: this field may return null, indicating that no valid values can be obtained.

setBindingKey

public void setBindingKey(String[] BindingKey)

Set Filtering policy for subscribing to and receiving messages. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

BindingKey - Filtering policy for subscribing to and receiving messages. Note: this field may return null, indicating that no valid values can be obtained.

getEndpoint

public String getEndpoint()

Get Endpoint that receives notifications, which varies by `protocol`: for HTTP, the endpoint must start with `http://`, and the `host` can be a domain or IP; for `queue`, `queueName` should be entered. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Endpoint Endpoint that receives notifications, which varies by `protocol`: for HTTP, the endpoint must start with `http://`, and the `host` can be a domain or IP; for `queue`, `queueName` should be entered. Note: this field may return null, indicating that no valid values can be obtained.

setEndpoint

public void setEndpoint(String Endpoint)

Set Endpoint that receives notifications, which varies by `protocol`: for HTTP, the endpoint must start with `http://`, and the `host` can be a domain or IP; for `queue`, `queueName` should be entered. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Endpoint - Endpoint that receives notifications, which varies by `protocol`: for HTTP, the endpoint must start with `http://`, and the `host` can be a domain or IP; for `queue`, `queueName` should be entered. Note: this field may return null, indicating that no valid values can be obtained.

getFilterTags

public String[] getFilterTags()

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:

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

setFilterTags

public void setFilterTags(String[] FilterTags)

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:

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

getProtocol

public String getProtocol()

Get Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Protocol Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently. Note: this field may return null, indicating that no valid values can be obtained.

setProtocol

public void setProtocol(String Protocol)

Set Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Protocol - Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently. Note: this field may return null, indicating that no valid values can be obtained.

getNotifyStrategy

public String getNotifyStrategy()

Get CMQ push server retry policy in case an error occurs while pushing a message to the endpoint. Valid values: (1) BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message. (2) EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

NotifyStrategy CMQ push server retry policy in case an error occurs while pushing a message to the endpoint. Valid values: (1) BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message. (2) EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY. Note: this field may return null, indicating that no valid values can be obtained.

setNotifyStrategy

public void setNotifyStrategy(String NotifyStrategy)

Set CMQ push server retry policy in case an error occurs while pushing a message to the endpoint. Valid values: (1) BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message. (2) EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

NotifyStrategy - CMQ push server retry policy in case an error occurs while pushing a message to the endpoint. Valid values: (1) BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message. (2) EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY. Note: this field may return null, indicating that no valid values can be obtained.

getNotifyContentFormat

public String getNotifyContentFormat()

Get Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If `protocol` is `queue`, this value must be `SIMPLIFIED`. If `protocol` is `HTTP`, both values are acceptable, and the default value is `JSON`. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

NotifyContentFormat Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If `protocol` is `queue`, this value must be `SIMPLIFIED`. If `protocol` is `HTTP`, both values are acceptable, and the default value is `JSON`. Note: this field may return null, indicating that no valid values can be obtained.

setNotifyContentFormat

public void setNotifyContentFormat(String NotifyContentFormat)

Set Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If `protocol` is `queue`, this value must be `SIMPLIFIED`. If `protocol` is `HTTP`, both values are acceptable, and the default value is `JSON`. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

NotifyContentFormat - Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If `protocol` is `queue`, this value must be `SIMPLIFIED`. If `protocol` is `HTTP`, both values are acceptable, and the default value is `JSON`. 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