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 Source database access type.
EndpointItem[]	getEndpoints() Get Database node information
KeyValuePairOption[]	getExtraAttr() Get Additional information added for the business.
SubscribeKafkaConfig	getKafkaConfig() Get Kafka configuration
PipelineInfo[]	getPipelineInfo() Get mongo optional parameter: output aggregation settings.
String	getProtocol() Get Subscription data format, such as: protobuf, json, avro.
String	getSubscribeId() Get Data subscription instance ID
String	getSubscribeMode() Get Data subscription type.
SubscribeObject[]	getSubscribeObjects() Get Subscription database table information.
void	setAccessType(String AccessType) Set Source database access type.
void	setEndpoints(EndpointItem[] Endpoints) Set Database node information
void	setExtraAttr(KeyValuePairOption[] ExtraAttr) Set Additional information added for the business.
void	setKafkaConfig(SubscribeKafkaConfig KafkaConfig) Set Kafka configuration
void	setPipelineInfo(PipelineInfo[] PipelineInfo) Set mongo optional parameter: output aggregation settings.
void	setProtocol(String Protocol) Set Subscription data format, such as: protobuf, json, avro.
void	setSubscribeId(String SubscribeId) Set Data subscription instance ID
void	setSubscribeMode(String SubscribeMode) Set Data subscription type.
void	setSubscribeObjects(SubscribeObject[] SubscribeObjects) Set Subscription database table information.
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, 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 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

getSubscribeMode

public String getSubscribeMode()

Get Data subscription type. Valid values for non-mongo DatabaseType: all (full instance update); dml (data update); ddl (structure update); dmlAndDdl (data + structure update). Valid values for mongo DatabaseType: all (full instance update); database (subscribe to a table); collection (subscribe to a collection).

Returns:

SubscribeMode Data subscription type. Valid values for non-mongo DatabaseType: all (full instance update); dml (data update); ddl (structure update); dmlAndDdl (data + structure update). Valid values for mongo DatabaseType: all (full instance update); database (subscribe to a table); collection (subscribe to a collection).

setSubscribeMode

public void setSubscribeMode(String SubscribeMode)

Set Data subscription type. Valid values for non-mongo DatabaseType: all (full instance update); dml (data update); ddl (structure update); dmlAndDdl (data + structure update). Valid values for mongo DatabaseType: all (full instance update); database (subscribe to a table); collection (subscribe to a collection).

Parameters:

SubscribeMode - Data subscription type. Valid values for non-mongo DatabaseType: all (full instance update); dml (data update); ddl (structure update); dmlAndDdl (data + structure update). Valid values for mongo DatabaseType: all (full instance update); database (subscribe to a table); collection (subscribe to a collection).

getAccessType

public String getAccessType()

Get Source database 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: The specific optional values depend on the current link support capabilities.

Returns:

AccessType Source database 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: The specific optional values depend on the current link support capabilities.

setAccessType

public void setAccessType(String AccessType)

Set Source database 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: The specific optional values depend on the current link support capabilities.

Parameters:

AccessType - Source database 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: The specific optional values depend on the current link support capabilities.

getEndpoints

public EndpointItem[] getEndpoints()

Get Database node information

Returns:

Endpoints Database node information

setEndpoints

public void setEndpoints(EndpointItem[] Endpoints)

Set Database node information

Parameters:

Endpoints - Database node information

getKafkaConfig

public SubscribeKafkaConfig getKafkaConfig()

Get Kafka configuration

Returns:

KafkaConfig Kafka configuration

setKafkaConfig

public void setKafkaConfig(SubscribeKafkaConfig KafkaConfig)

Set Kafka configuration

Parameters:

KafkaConfig - Kafka configuration

getSubscribeObjects

public SubscribeObject[] getSubscribeObjects()

Get Subscription database table information. When SubscribeMode is not all or ddl, SubscribeObjects is a required parameter.

Returns:

SubscribeObjects Subscription database table information. When SubscribeMode is not all or ddl, SubscribeObjects is a required parameter.

setSubscribeObjects

public void setSubscribeObjects(SubscribeObject[] SubscribeObjects)

Set Subscription database table information. When SubscribeMode is not all or ddl, SubscribeObjects is a required parameter.

Parameters:

SubscribeObjects - Subscription database table information. When SubscribeMode is not all or ddl, SubscribeObjects is a required parameter.

getProtocol

public String getProtocol()

Get Subscription data format, such as: protobuf, json, avro. Note: The specific optional values depend on the current link support capabilities. For details on the data format, please refer to the consumption demo documentation on the official website.

Returns:

Protocol Subscription data format, such as: protobuf, json, avro. Note: The specific optional values depend on the current link support capabilities. For details on the data format, please refer to the consumption demo documentation on the official website.

setProtocol

public void setProtocol(String Protocol)

Set Subscription data format, such as: protobuf, json, avro. Note: The specific optional values depend on the current link support capabilities. For details on the data format, please refer to the consumption demo documentation on the official website.

Parameters:

Protocol - Subscription data format, such as: protobuf, json, avro. Note: The specific optional values depend on the current link support capabilities. For details on the data format, please refer to the consumption demo documentation on the official website.

getPipelineInfo

public PipelineInfo[] getPipelineInfo()

Get mongo optional parameter: output aggregation settings.

Returns:

PipelineInfo mongo optional parameter: output aggregation settings.

setPipelineInfo

public void setPipelineInfo(PipelineInfo[] PipelineInfo)

Set mongo optional parameter: output aggregation settings.

Parameters:

PipelineInfo - mongo optional parameter: output aggregation settings.

getExtraAttr

public KeyValuePairOption[] getExtraAttr()

Get Additional information added for the business. The parameter name is called key, and the parameter value is called value.Optional parameters for mysql: ProcessXA. If true is filled in, it will be processed. If it is left blank or filled with other values, it will not be processed.Optional parameters for mongo: SubscribeType. Currently only changeStream is supported. If not filled in, the default is changeStream.Other businesses currently have no optional parameters.

Returns:

ExtraAttr Additional information added for the business. The parameter name is called key, and the parameter value is called value.Optional parameters for mysql: ProcessXA. If true is filled in, it will be processed. If it is left blank or filled with other values, it will not be processed.Optional parameters for mongo: SubscribeType. Currently only changeStream is supported. If not filled in, the default is changeStream.Other businesses currently have no optional parameters.

setExtraAttr

public void setExtraAttr(KeyValuePairOption[] ExtraAttr)

Set Additional information added for the business. The parameter name is called key, and the parameter value is called value.Optional parameters for mysql: ProcessXA. If true is filled in, it will be processed. If it is left blank or filled with other values, it will not be processed.Optional parameters for mongo: SubscribeType. Currently only changeStream is supported. If not filled in, the default is changeStream.Other businesses currently have no optional parameters.

Parameters:

ExtraAttr - Additional information added for the business. The parameter name is called key, and the parameter value is called value.Optional parameters for mysql: ProcessXA. If true is filled in, it will be processed. If it is left blank or filled with other values, it will not be processed.Optional parameters for mongo: SubscribeType. Currently only changeStream is supported. If not filled in, the default is changeStream.Other businesses currently have no optional parameters.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel