com.tencentcloudapi.dts.v20211206.models

Class ConfigureSyncJobRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.dts.v20211206.models.ConfigureSyncJobRequest

public class ConfigureSyncJobRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ConfigureSyncJobRequest()
ConfigureSyncJobRequest(ConfigureSyncJobRequest 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
Long	getAutoRetryTimeRangeMinutes() Get Automatic retry time, which can be set to 5-720 minutes.
String	getDstAccessType() Get Target database access type.
Endpoint	getDstInfo() Get Target database information.
SyncDBEndpointInfos	getDstInfos() Get Target database information.
String	getDstNodeType() Get Enumerated values: `single` (for single-node target database), `cluster` (for multi-node target database).
String	getExpectRunTime() Get Expected start time in the format of "2006-01-02 15:04:05", which is required if `RunMode` is `Timed`.
String	getJobId() Get Sync task instance ID in the format of `sync-werwfs23`, which is used to identify a sync task.
String	getJobMode() Get Enumerated values: `liteMode`: Lite mode; `fullMode`: Standard mode
String	getJobName() Get Sync task name
Objects	getObjects() Get Information of synced database/table objects
Options	getOptions() Get Sync task options
String	getRunMode() Get Running mode.
String	getSrcAccessType() Get Source database access type.
Endpoint	getSrcInfo() Get Source database information.
SyncDBEndpointInfos	getSrcInfos() Get Source database information.
String	getSrcNodeType() Get Enumerated values: `single` (for single-node source database), `cluster` (for multi-node source database).
void	setAutoRetryTimeRangeMinutes(Long AutoRetryTimeRangeMinutes) Set Automatic retry time, which can be set to 5-720 minutes.
void	setDstAccessType(String DstAccessType) Set Target database access type.
void	setDstInfo(Endpoint DstInfo) Set Target database information.
void	setDstInfos(SyncDBEndpointInfos DstInfos) Set Target database information.
void	setDstNodeType(String DstNodeType) Set Enumerated values: `single` (for single-node target database), `cluster` (for multi-node target database).
void	setExpectRunTime(String ExpectRunTime) Set Expected start time in the format of "2006-01-02 15:04:05", which is required if `RunMode` is `Timed`.
void	setJobId(String JobId) Set Sync task instance ID in the format of `sync-werwfs23`, which is used to identify a sync task.
void	setJobMode(String JobMode) Set Enumerated values: `liteMode`: Lite mode; `fullMode`: Standard mode
void	setJobName(String JobName) Set Sync task name
void	setObjects(Objects Objects) Set Information of synced database/table objects
void	setOptions(Options Options) Set Sync task options
void	setRunMode(String RunMode) Set Running mode.
void	setSrcAccessType(String SrcAccessType) Set Source database access type.
void	setSrcInfo(Endpoint SrcInfo) Set Source database information.
void	setSrcInfos(SyncDBEndpointInfos SrcInfos) Set Source database information.
void	setSrcNodeType(String SrcNodeType) Set Enumerated values: `single` (for single-node source database), `cluster` (for multi-node source database).
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

ConfigureSyncJobRequest

public ConfigureSyncJobRequest()

ConfigureSyncJobRequest

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

getJobId

public String getJobId()

Get Sync task instance ID in the format of `sync-werwfs23`, which is used to identify a sync task.

Returns:

JobId Sync task instance ID in the format of `sync-werwfs23`, which is used to identify a sync task.

setJobId

public void setJobId(String JobId)

Set Sync task instance ID in the format of `sync-werwfs23`, which is used to identify a sync task.

Parameters:

JobId - Sync task instance ID in the format of `sync-werwfs23`, which is used to identify a sync task.

getSrcAccessType

public String getSrcAccessType()

Get Source database access type. Valid values: `cdb` (database); `cvm` (self-build on CVM); `vpc` (VPC); `extranet` (public network); `vpncloud` (VPN access); `dcg` (Direct Connect); `ccn` (CCN); `intranet` (intranet). Note that the valid values are subject to the current link.

Returns:

SrcAccessType Source database access type. Valid values: `cdb` (database); `cvm` (self-build on CVM); `vpc` (VPC); `extranet` (public network); `vpncloud` (VPN access); `dcg` (Direct Connect); `ccn` (CCN); `intranet` (intranet). Note that the valid values are subject to the current link.

setSrcAccessType

public void setSrcAccessType(String SrcAccessType)

Set Source database access type. Valid values: `cdb` (database); `cvm` (self-build on CVM); `vpc` (VPC); `extranet` (public network); `vpncloud` (VPN access); `dcg` (Direct Connect); `ccn` (CCN); `intranet` (intranet). Note that the valid values are subject to the current link.

Parameters:

SrcAccessType - Source database access type. Valid values: `cdb` (database); `cvm` (self-build on CVM); `vpc` (VPC); `extranet` (public network); `vpncloud` (VPN access); `dcg` (Direct Connect); `ccn` (CCN); `intranet` (intranet). Note that the valid values are subject to the current link.

getDstAccessType

public String getDstAccessType()

Get Target database access type. Valid values: `cdb` (database); `cvm` (self-build on CVM); `vpc` (VPC); `extranet` (public network); `vpncloud` (VPN access); `dcg` (Direct Connect); `ccn` (CCN); `intranet` (intranet); `ckafka` (CKafka instance). Note that the valid values are subject to the current link.

Returns:

DstAccessType Target database access type. Valid values: `cdb` (database); `cvm` (self-build on CVM); `vpc` (VPC); `extranet` (public network); `vpncloud` (VPN access); `dcg` (Direct Connect); `ccn` (CCN); `intranet` (intranet); `ckafka` (CKafka instance). Note that the valid values are subject to the current link.

setDstAccessType

public void setDstAccessType(String DstAccessType)

Set Target database access type. Valid values: `cdb` (database); `cvm` (self-build on CVM); `vpc` (VPC); `extranet` (public network); `vpncloud` (VPN access); `dcg` (Direct Connect); `ccn` (CCN); `intranet` (intranet); `ckafka` (CKafka instance). Note that the valid values are subject to the current link.

Parameters:

DstAccessType - Target database access type. Valid values: `cdb` (database); `cvm` (self-build on CVM); `vpc` (VPC); `extranet` (public network); `vpncloud` (VPN access); `dcg` (Direct Connect); `ccn` (CCN); `intranet` (intranet); `ckafka` (CKafka instance). Note that the valid values are subject to the current link.

getObjects

public Objects getObjects()

Get Information of synced database/table objects

Returns:

Objects Information of synced database/table objects

setObjects

public void setObjects(Objects Objects)

Set Information of synced database/table objects

Parameters:

Objects - Information of synced database/table objects

getJobName

public String getJobName()

Get Sync task name

Returns:

JobName Sync task name

setJobName

public void setJobName(String JobName)

Set Sync task name

Parameters:

JobName - Sync task name

getJobMode

public String getJobMode()

Get Enumerated values: `liteMode`: Lite mode; `fullMode`: Standard mode

Returns:

JobMode Enumerated values: `liteMode`: Lite mode; `fullMode`: Standard mode

setJobMode

public void setJobMode(String JobMode)

Set Enumerated values: `liteMode`: Lite mode; `fullMode`: Standard mode

Parameters:

JobMode - Enumerated values: `liteMode`: Lite mode; `fullMode`: Standard mode

getRunMode

public String getRunMode()

Get Running mode. Valid values: `Immediate`, `Timed`. Default value: `Immediate`.

Returns:

RunMode Running mode. Valid values: `Immediate`, `Timed`. Default value: `Immediate`.

setRunMode

public void setRunMode(String RunMode)

Set Running mode. Valid values: `Immediate`, `Timed`. Default value: `Immediate`.

Parameters:

RunMode - Running mode. Valid values: `Immediate`, `Timed`. Default value: `Immediate`.

getExpectRunTime

public String getExpectRunTime()

Get Expected start time in the format of "2006-01-02 15:04:05", which is required if `RunMode` is `Timed`.

Returns:

ExpectRunTime Expected start time in the format of "2006-01-02 15:04:05", which is required if `RunMode` is `Timed`.

setExpectRunTime

public void setExpectRunTime(String ExpectRunTime)

Set Expected start time in the format of "2006-01-02 15:04:05", which is required if `RunMode` is `Timed`.

Parameters:

ExpectRunTime - Expected start time in the format of "2006-01-02 15:04:05", which is required if `RunMode` is `Timed`.

getSrcInfo

public Endpoint getSrcInfo()

Get Source database information. This parameter only applies to single-node databases, and `SrcNodeType` must be `single`.

Returns:

SrcInfo Source database information. This parameter only applies to single-node databases, and `SrcNodeType` must be `single`.

setSrcInfo

public void setSrcInfo(Endpoint SrcInfo)

Set Source database information. This parameter only applies to single-node databases, and `SrcNodeType` must be `single`.

Parameters:

SrcInfo - Source database information. This parameter only applies to single-node databases, and `SrcNodeType` must be `single`.

getSrcInfos

public SyncDBEndpointInfos getSrcInfos()

Get Source database information. This parameter is valid for multi-node databases, and the value of `SrcNodeType` must be `cluster`.

Returns:

SrcInfos Source database information. This parameter is valid for multi-node databases, and the value of `SrcNodeType` must be `cluster`.

setSrcInfos

public void setSrcInfos(SyncDBEndpointInfos SrcInfos)

Set Source database information. This parameter is valid for multi-node databases, and the value of `SrcNodeType` must be `cluster`.

Parameters:

SrcInfos - Source database information. This parameter is valid for multi-node databases, and the value of `SrcNodeType` must be `cluster`.

getSrcNodeType

public String getSrcNodeType()

Get Enumerated values: `single` (for single-node source database), `cluster` (for multi-node source database).

Returns:

SrcNodeType Enumerated values: `single` (for single-node source database), `cluster` (for multi-node source database).

setSrcNodeType

public void setSrcNodeType(String SrcNodeType)

Set Enumerated values: `single` (for single-node source database), `cluster` (for multi-node source database).

Parameters:

SrcNodeType - Enumerated values: `single` (for single-node source database), `cluster` (for multi-node source database).

getDstInfo

public Endpoint getDstInfo()

Get Target database information. This parameter is used by single-node databases.

Returns:

DstInfo Target database information. This parameter is used by single-node databases.

setDstInfo

public void setDstInfo(Endpoint DstInfo)

Set Target database information. This parameter is used by single-node databases.

Parameters:

DstInfo - Target database information. This parameter is used by single-node databases.

getDstInfos

public SyncDBEndpointInfos getDstInfos()

Get Target database information. This parameter is valid for multi-node databases, and the value of `DstNodeType` must be `cluster`.

Returns:

DstInfos Target database information. This parameter is valid for multi-node databases, and the value of `DstNodeType` must be `cluster`.

setDstInfos

public void setDstInfos(SyncDBEndpointInfos DstInfos)

Set Target database information. This parameter is valid for multi-node databases, and the value of `DstNodeType` must be `cluster`.

Parameters:

DstInfos - Target database information. This parameter is valid for multi-node databases, and the value of `DstNodeType` must be `cluster`.

getDstNodeType

public String getDstNodeType()

Get Enumerated values: `single` (for single-node target database), `cluster` (for multi-node target database).

Returns:

DstNodeType Enumerated values: `single` (for single-node target database), `cluster` (for multi-node target database).

setDstNodeType

public void setDstNodeType(String DstNodeType)

Set Enumerated values: `single` (for single-node target database), `cluster` (for multi-node target database).

Parameters:

DstNodeType - Enumerated values: `single` (for single-node target database), `cluster` (for multi-node target database).

getOptions

public Options getOptions()

Get Sync task options

Returns:

Options Sync task options

setOptions

public void setOptions(Options Options)

Set Sync task options

Parameters:

Options - Sync task options

getAutoRetryTimeRangeMinutes

public Long getAutoRetryTimeRangeMinutes()

Get Automatic retry time, which can be set to 5-720 minutes. 0 indicates that retry is disabled.

Returns:

AutoRetryTimeRangeMinutes Automatic retry time, which can be set to 5-720 minutes. 0 indicates that retry is disabled.

setAutoRetryTimeRangeMinutes

public void setAutoRetryTimeRangeMinutes(Long AutoRetryTimeRangeMinutes)

Set Automatic retry time, which can be set to 5-720 minutes. 0 indicates that retry is disabled.

Parameters:

AutoRetryTimeRangeMinutes - Automatic retry time, which can be set to 5-720 minutes. 0 indicates that retry is disabled.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel