com.tencentcloudapi.dts.v20211206.models

Class SubscribeInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.dts.v20211206.models.SubscribeInfo

public class SubscribeInfo
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
SubscribeInfo()
SubscribeInfo(SubscribeInfo 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	getAccessType() Get Access type.
Long	getAutoRenewFlag() Get Auto-renewal flag.
String	getCreateTime() Get Creation time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.
EndpointItem[]	getEndpoints() Get Database node information Note: This field may return null, indicating that no valid values can be obtained.
SubsErr[]	getErrors() Get Task error messageNote: This field may return null, indicating that no valid values can be obtained.
String	getExpireTime() Get Expiration time for monthly subscription tasks, the format is: Y-m-d h:m:s.
String	getInstanceId() Get The subscribed database instance ID (if the subscription is a cloud database).
String	getInstanceStatus() Get Cloud database status: running, isolated, offline.
String	getIsolateTime() Get Isolation time, the format is: Y-m-d h:m:s.
String	getModifyTime() Get Last modification time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.
String	getOfflineTime() Get Offline time, the format is: Y-m-d h:m:s.
Long	getPayType() Get Billing mode.
String	getProduct() Get Subscription instance type.
String	getRegion() Get Data subscription instance region
String	getStatus() Get Data subscription lifecycle status.
String	getSubscribeId() Get Data subscription instance ID
String	getSubscribeName() Get Data subscription instance name
String	getSubscribeVersion() Get Data subscription version, only Kafka version is currently supported.Note: This field may return null, indicating that no valid values can be obtained.
String	getSubsStatus() Get Data subscription status.
TagItem[]	getTags() Get TagNote: This field may return null, indicating that no valid values can be obtained.
String	getTopic() Get Kafka topic for data sent by the subscription instance Note: This field may return null, indicating that no valid values can be obtained.
void	setAccessType(String AccessType) Set Access type.
void	setAutoRenewFlag(Long AutoRenewFlag) Set Auto-renewal flag.
void	setCreateTime(String CreateTime) Set Creation time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.
void	setEndpoints(EndpointItem[] Endpoints) Set Database node information Note: This field may return null, indicating that no valid values can be obtained.
void	setErrors(SubsErr[] Errors) Set Task error messageNote: This field may return null, indicating that no valid values can be obtained.
void	setExpireTime(String ExpireTime) Set Expiration time for monthly subscription tasks, the format is: Y-m-d h:m:s.
void	setInstanceId(String InstanceId) Set The subscribed database instance ID (if the subscription is a cloud database).
void	setInstanceStatus(String InstanceStatus) Set Cloud database status: running, isolated, offline.
void	setIsolateTime(String IsolateTime) Set Isolation time, the format is: Y-m-d h:m:s.
void	setModifyTime(String ModifyTime) Set Last modification time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.
void	setOfflineTime(String OfflineTime) Set Offline time, the format is: Y-m-d h:m:s.
void	setPayType(Long PayType) Set Billing mode.
void	setProduct(String Product) Set Subscription instance type.
void	setRegion(String Region) Set Data subscription instance region
void	setStatus(String Status) Set Data subscription lifecycle status.
void	setSubscribeId(String SubscribeId) Set Data subscription instance ID
void	setSubscribeName(String SubscribeName) Set Data subscription instance name
void	setSubscribeVersion(String SubscribeVersion) Set Data subscription version, only Kafka version is currently supported.Note: This field may return null, indicating that no valid values can be obtained.
void	setSubsStatus(String SubsStatus) Set Data subscription status.
void	setTags(TagItem[] Tags) Set TagNote: This field may return null, indicating that no valid values can be obtained.
void	setTopic(String Topic) Set Kafka topic for data sent by the subscription instance Note: This field may return null, indicating that no valid values can be obtained.
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

SubscribeInfo

public SubscribeInfo()

SubscribeInfo

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

getSubscribeId

public String getSubscribeId()

Get Data subscription instance ID

Returns:

SubscribeId Data subscription instance ID

setSubscribeId

public void setSubscribeId(String SubscribeId)

Set Data subscription instance ID

Parameters:

SubscribeId - Data subscription instance ID

getSubscribeName

public String getSubscribeName()

Get Data subscription instance name

Returns:

SubscribeName Data subscription instance name

setSubscribeName

public void setSubscribeName(String SubscribeName)

Set Data subscription instance name

Parameters:

SubscribeName - Data subscription instance name

getTopic

public String getTopic()

Get Kafka topic for data sent by the subscription instance Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Topic Kafka topic for data sent by the subscription instance Note: This field may return null, indicating that no valid values can be obtained.

setTopic

public void setTopic(String Topic)

Set Kafka topic for data sent by the subscription instance Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Topic - Kafka topic for data sent by the subscription instance Note: This field may return null, indicating that no valid values can be obtained.

getProduct

public String getProduct()

Get Subscription instance type. Currently, cynosdbmysql, mariadb, mongodb, mysql, percona, tdpg, tdsqlpercona are supported.

Returns:

Product Subscription instance type. Currently, cynosdbmysql, mariadb, mongodb, mysql, percona, tdpg, tdsqlpercona are supported.

setProduct

public void setProduct(String Product)

Set Subscription instance type. Currently, cynosdbmysql, mariadb, mongodb, mysql, percona, tdpg, tdsqlpercona are supported.

Parameters:

Product - Subscription instance type. Currently, cynosdbmysql, mariadb, mongodb, mysql, percona, tdpg, tdsqlpercona are supported.

getInstanceId

public String getInstanceId()

Get The subscribed database instance ID (if the subscription is a cloud database). If the instance is not on Tencent Cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.

Returns:

InstanceId The subscribed database instance ID (if the subscription is a cloud database). If the instance is not on Tencent Cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.

setInstanceId

public void setInstanceId(String InstanceId)

Set The subscribed database instance ID (if the subscription is a cloud database). If the instance is not on Tencent Cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

InstanceId - The subscribed database instance ID (if the subscription is a cloud database). If the instance is not on Tencent Cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.

getInstanceStatus

public String getInstanceStatus()

Get Cloud database status: running, isolated, offline. If it is not on the cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.

Returns:

InstanceStatus Cloud database status: running, isolated, offline. If it is not on the cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.

setInstanceStatus

public void setInstanceStatus(String InstanceStatus)

Set Cloud database status: running, isolated, offline. If it is not on the cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

InstanceStatus - Cloud database status: running, isolated, offline. If it is not on the cloud, this value is empty.Note: This field may return null, indicating that no valid values can be obtained.

getStatus

public String getStatus()

Get Data subscription lifecycle status. Valid values: normal (normal), isolating (isolating), isolated (isolated), offlining (offlining), post2PrePayIng (changing from pay-as-you-go to monthly subscription).

Returns:

Status Data subscription lifecycle status. Valid values: normal (normal), isolating (isolating), isolated (isolated), offlining (offlining), post2PrePayIng (changing from pay-as-you-go to monthly subscription).

setStatus

public void setStatus(String Status)

Set Data subscription lifecycle status. Valid values: normal (normal), isolating (isolating), isolated (isolated), offlining (offlining), post2PrePayIng (changing from pay-as-you-go to monthly subscription).

Parameters:

Status - Data subscription lifecycle status. Valid values: normal (normal), isolating (isolating), isolated (isolated), offlining (offlining), post2PrePayIng (changing from pay-as-you-go to monthly subscription).

getSubsStatus

public String getSubsStatus()

Get Data subscription status. Valid values: notStarted, checking, checkNotPass, checkPass, starting, running, error.

Returns:

SubsStatus Data subscription status. Valid values: notStarted, checking, checkNotPass, checkPass, starting, running, error.

setSubsStatus

public void setSubsStatus(String SubsStatus)

Set Data subscription status. Valid values: notStarted, checking, checkNotPass, checkPass, starting, running, error.

Parameters:

SubsStatus - Data subscription status. Valid values: notStarted, checking, checkNotPass, checkPass, starting, running, error.

getModifyTime

public String getModifyTime()

Get Last modification time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ModifyTime Last modification time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.

setModifyTime

public void setModifyTime(String ModifyTime)

Set Last modification time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ModifyTime - Last modification time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.

getCreateTime

public String getCreateTime()

Get Creation time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.

Returns:

CreateTime Creation time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.

setCreateTime

public void setCreateTime(String CreateTime)

Set Creation time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

CreateTime - Creation time, the format is: Y-m-d h:m:s.Note: This field may return null, indicating that no valid values can be obtained.

getIsolateTime

public String getIsolateTime()

Get Isolation time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

Returns:

IsolateTime Isolation time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

setIsolateTime

public void setIsolateTime(String IsolateTime)

Set Isolation time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

IsolateTime - Isolation time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

getExpireTime

public String getExpireTime()

Get Expiration time for monthly subscription tasks, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ExpireTime Expiration time for monthly subscription tasks, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

setExpireTime

public void setExpireTime(String ExpireTime)

Set Expiration time for monthly subscription tasks, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ExpireTime - Expiration time for monthly subscription tasks, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

getOfflineTime

public String getOfflineTime()

Get Offline time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

Returns:

OfflineTime Offline time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

setOfflineTime

public void setOfflineTime(String OfflineTime)

Set Offline time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

OfflineTime - Offline time, the format is: Y-m-d h:m:s. Default time: 0000-00-00 00:00:00.Note: This field may return null, indicating that no valid values can be obtained.

getPayType

public Long getPayType()

Get Billing mode. 1: pay-as-you-go

Returns:

PayType Billing mode. 1: pay-as-you-go

setPayType

public void setPayType(Long PayType)

Set Billing mode. 1: pay-as-you-go

Parameters:

PayType - Billing mode. 1: pay-as-you-go

getAutoRenewFlag

public Long getAutoRenewFlag()

Get Auto-renewal flag. It is meaningful only when PayType=0. Valid values: 0 (auto-renewal disabled); 1 (auto-renewal enabled).

Returns:

AutoRenewFlag Auto-renewal flag. It is meaningful only when PayType=0. Valid values: 0 (auto-renewal disabled); 1 (auto-renewal enabled).

setAutoRenewFlag

public void setAutoRenewFlag(Long AutoRenewFlag)

Set Auto-renewal flag. It is meaningful only when PayType=0. Valid values: 0 (auto-renewal disabled); 1 (auto-renewal enabled).

Parameters:

AutoRenewFlag - Auto-renewal flag. It is meaningful only when PayType=0. Valid values: 0 (auto-renewal disabled); 1 (auto-renewal enabled).

getRegion

public String getRegion()

Get Data subscription instance region

Returns:

Region Data subscription instance region

setRegion

public void setRegion(String Region)

Set Data subscription instance region

Parameters:

Region - Data subscription instance region

getAccessType

public String getAccessType()

Get Access type. Valid values: extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); cdb (database); cvm (self-build on CVM); intranet (intranet); vpc (VPC).Note: This field may return null, indicating that no valid values can be obtained.

Returns:

AccessType Access type. Valid values: extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); cdb (database); cvm (self-build on CVM); intranet (intranet); vpc (VPC).Note: This field may return null, indicating that no valid values can be obtained.

setAccessType

public void setAccessType(String AccessType)

Set Access type. Valid values: extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); cdb (database); cvm (self-build on CVM); intranet (intranet); vpc (VPC).Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

AccessType - Access type. Valid values: extranet (public network); vpncloud (VPN access); dcg (Direct Connect); ccn (CCN); cdb (database); cvm (self-build on CVM); intranet (intranet); vpc (VPC).Note: This field may return null, indicating that no valid values can be obtained.

getEndpoints

public EndpointItem[] getEndpoints()

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

Returns:

Endpoints Database node information Note: This field may return null, indicating that no valid values can be obtained.

setEndpoints

public void setEndpoints(EndpointItem[] Endpoints)

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

Parameters:

Endpoints - Database node information Note: This field may return null, indicating that no valid values can be obtained.

getSubscribeVersion

public String getSubscribeVersion()

Get Data subscription version, only Kafka version is currently supported.Note: This field may return null, indicating that no valid values can be obtained.

Returns:

SubscribeVersion Data subscription version, only Kafka version is currently supported.Note: This field may return null, indicating that no valid values can be obtained.

setSubscribeVersion

public void setSubscribeVersion(String SubscribeVersion)

Set Data subscription version, only Kafka version is currently supported.Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

SubscribeVersion - Data subscription version, only Kafka version is currently supported.Note: This field may return null, indicating that no valid values can be obtained.

getTags

public TagItem[] getTags()

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

Returns:

Tags TagNote: This field may return null, indicating that no valid values can be obtained.

setTags

public void setTags(TagItem[] Tags)

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

Parameters:

Tags - TagNote: This field may return null, indicating that no valid values can be obtained.

getErrors

public SubsErr[] getErrors()

Get Task error messageNote: This field may return null, indicating that no valid values can be obtained.

Returns:

Errors Task error messageNote: This field may return null, indicating that no valid values can be obtained.

setErrors

public void setErrors(SubsErr[] Errors)

Set Task error messageNote: This field may return null, indicating that no valid values can be obtained.

Parameters:

Errors - Task error messageNote: 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

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.