com.tencentcloudapi.dts.v20211206.models

Class ConfigureSubscribeJobRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.dts.v20211206.models.ConfigureSubscribeJobRequest

public class ConfigureSubscribeJobRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ConfigureSubscribeJobRequest()
ConfigureSubscribeJobRequest(ConfigureSubscribeJobRequest 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 源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力
String	getConsumerSubnetId() Get subnet id
String	getConsumerVpcId() Get vpc id
EndpointItem[]	getEndpoints() Get 数据库节点信息
KeyValuePairOption[]	getExtraAttr() Get 为业务添加的额外信息。参数名作key，参数值作value。 mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。
SubscribeKafkaConfig	getKafkaConfig() Get Kafka配置
PipelineInfo[]	getPipelineInfo() Get mongo选填参数：输出聚合设置。
String	getProtocol() Get 订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档
String	getSubscribeId() Get 数据订阅实例的 ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
String	getSubscribeMode() Get 数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合
SubscribeObject[]	getSubscribeObjects() Get 订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数
void	setAccessType(String AccessType) Set 源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力
void	setConsumerSubnetId(String ConsumerSubnetId) Set subnet id
void	setConsumerVpcId(String ConsumerVpcId) Set vpc id
void	setEndpoints(EndpointItem[] Endpoints) Set 数据库节点信息
void	setExtraAttr(KeyValuePairOption[] ExtraAttr) Set 为业务添加的额外信息。参数名作key，参数值作value。 mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。
void	setKafkaConfig(SubscribeKafkaConfig KafkaConfig) Set Kafka配置
void	setPipelineInfo(PipelineInfo[] PipelineInfo) Set mongo选填参数：输出聚合设置。
void	setProtocol(String Protocol) Set 订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档
void	setSubscribeId(String SubscribeId) Set 数据订阅实例的 ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。
void	setSubscribeMode(String SubscribeMode) Set 数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合
void	setSubscribeObjects(SubscribeObject[] SubscribeObjects) Set 订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数
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

ConfigureSubscribeJobRequest

public ConfigureSubscribeJobRequest()

ConfigureSubscribeJobRequest

public ConfigureSubscribeJobRequest(ConfigureSubscribeJobRequest 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 数据订阅实例的 ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。

Returns:

SubscribeId 数据订阅实例的 ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。

setSubscribeId

public void setSubscribeId(String SubscribeId)

Set 数据订阅实例的 ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。

Parameters:

SubscribeId - 数据订阅实例的 ID，可通过[DescribeSyncJobs](https://cloud.tencent.com/document/product/571/82103)接口获取。

getSubscribeMode

public String getSubscribeMode()

Get 数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

Returns:

SubscribeMode 数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

setSubscribeMode

public void setSubscribeMode(String SubscribeMode)

Set 数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

Parameters:

SubscribeMode - 数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

getAccessType

public String getAccessType()

Get 源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

Returns:

AccessType 源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

setAccessType

public void setAccessType(String AccessType)

Set 源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

Parameters:

AccessType - 源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

getEndpoints

public EndpointItem[] getEndpoints()

Get 数据库节点信息

Returns:

Endpoints 数据库节点信息

setEndpoints

public void setEndpoints(EndpointItem[] Endpoints)

Set 数据库节点信息

Parameters:

Endpoints - 数据库节点信息

getKafkaConfig

public SubscribeKafkaConfig getKafkaConfig()

Get Kafka配置

Returns:

KafkaConfig Kafka配置

setKafkaConfig

public void setKafkaConfig(SubscribeKafkaConfig KafkaConfig)

Set Kafka配置

Parameters:

KafkaConfig - Kafka配置

getSubscribeObjects

public SubscribeObject[] getSubscribeObjects()

Get 订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

Returns:

SubscribeObjects 订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

setSubscribeObjects

public void setSubscribeObjects(SubscribeObject[] SubscribeObjects)

Set 订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

Parameters:

SubscribeObjects - 订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

getProtocol

public String getProtocol()

Get 订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

Returns:

Protocol 订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

setProtocol

public void setProtocol(String Protocol)

Set 订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

Parameters:

Protocol - 订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

getPipelineInfo

public PipelineInfo[] getPipelineInfo()

Get mongo选填参数：输出聚合设置。

Returns:

PipelineInfo mongo选填参数：输出聚合设置。

setPipelineInfo

public void setPipelineInfo(PipelineInfo[] PipelineInfo)

Set mongo选填参数：输出聚合设置。

Parameters:

PipelineInfo - mongo选填参数：输出聚合设置。

getExtraAttr

public KeyValuePairOption[] getExtraAttr()

Get 为业务添加的额外信息。参数名作key，参数值作value。 mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Returns:

ExtraAttr 为业务添加的额外信息。参数名作key，参数值作value。 mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

setExtraAttr

public void setExtraAttr(KeyValuePairOption[] ExtraAttr)

Set 为业务添加的额外信息。参数名作key，参数值作value。 mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

ExtraAttr - 为业务添加的额外信息。参数名作key，参数值作value。 mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

getConsumerVpcId

public String getConsumerVpcId()

Get vpc id

Returns:

ConsumerVpcId vpc id

setConsumerVpcId

public void setConsumerVpcId(String ConsumerVpcId)

Set vpc id

Parameters:

ConsumerVpcId - vpc id

getConsumerSubnetId

public String getConsumerSubnetId()

Get subnet id

Returns:

ConsumerSubnetId subnet id

setConsumerSubnetId

public void setConsumerSubnetId(String ConsumerSubnetId)

Set subnet id

Parameters:

ConsumerSubnetId - subnet id

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.