Options (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.dts.v20211206.models.Options

public class Options
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`Options()`
`Options(Options 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAddAdditionalColumn()` Get 是否添加附加列
`Long`	`getAutoRetryTimeRangeMinutes()` Get 自动重试的时间窗口设置
`ConflictHandleOption`	`getConflictHandleOption()` Get 冲突处理的详细选项，如条件覆盖中的条件行和条件操作
`String`	`getConflictHandleType()` Get 冲突处理选项，ReportError(报错，默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
`DdlOption[]`	`getDdlOptions()` Get DDL同步选项，具体描述要同步哪些DDL 注意：此字段可能返回 null，表示取不到有效值。
`String`	`getDealOfExistSameTable()` Get 同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)
`Boolean`	`getFilterBeginCommit()` Get 同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持
`Boolean`	`getFilterCheckpoint()` Get 同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持
`String`	`getInitType()` Get 同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。
`KafkaOption`	`getKafkaOption()` Get kafka同步选项
`String[]`	`getOpTypes()` Get 所要同步的DML和DDL的选项，Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步)， PartialDDL(自定义,和DdlOptions一起配合使用)。注意，这里至少需要包含DML中的一种。注意：此字段可能返回 null，表示取不到有效值。
`RateLimitOption`	`getRateLimitOption()` Get 任务限速信息
`String`	`getStartPosition()` Get 同步到kafka链路指定位点。目前只支持时间格式：2023-12-20T19:24:23+08:00。如果没有指定位点，为空。
`void`	`setAddAdditionalColumn(Boolean AddAdditionalColumn)` Set 是否添加附加列
`void`	`setAutoRetryTimeRangeMinutes(Long AutoRetryTimeRangeMinutes)` Set 自动重试的时间窗口设置
`void`	`setConflictHandleOption(ConflictHandleOption ConflictHandleOption)` Set 冲突处理的详细选项，如条件覆盖中的条件行和条件操作
`void`	`setConflictHandleType(String ConflictHandleType)` Set 冲突处理选项，ReportError(报错，默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
`void`	`setDdlOptions(DdlOption[] DdlOptions)` Set DDL同步选项，具体描述要同步哪些DDL 注意：此字段可能返回 null，表示取不到有效值。
`void`	`setDealOfExistSameTable(String DealOfExistSameTable)` Set 同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)
`void`	`setFilterBeginCommit(Boolean FilterBeginCommit)` Set 同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持
`void`	`setFilterCheckpoint(Boolean FilterCheckpoint)` Set 同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持
`void`	`setInitType(String InitType)` Set 同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。
`void`	`setKafkaOption(KafkaOption KafkaOption)` Set kafka同步选项
`void`	`setOpTypes(String[] OpTypes)` Set 所要同步的DML和DDL的选项，Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步)， PartialDDL(自定义,和DdlOptions一起配合使用)。注意，这里至少需要包含DML中的一种。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setRateLimitOption(RateLimitOption RateLimitOption)` Set 任务限速信息
`void`	`setStartPosition(String StartPosition)` Set 同步到kafka链路指定位点。目前只支持时间格式：2023-12-20T19:24:23+08:00。如果没有指定位点，为空。
`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
  - Options
```
public Options()
```
  - Options
```
public Options(Options 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
  - getInitType
```
public String getInitType()
```
    Get 同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。
    
    Returns:
    
    InitType 同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。
  - setInitType
```
public void setInitType(String InitType)
```
    Set 同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。
    
    Parameters:
    
    InitType - 同步初始化选项，Data(全量数据初始化)、Structure(结构初始化)、Full(全量数据且结构初始化，默认)、None(仅增量)；mongodb链路只支持全量数据初始化或仅增量。
  - getDealOfExistSameTable
```
public String getDealOfExistSameTable()
```
    Get 同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)
    
    Returns:
    
    DealOfExistSameTable 同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)
  - setDealOfExistSameTable
```
public void setDealOfExistSameTable(String DealOfExistSameTable)
```
    Set 同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)
    
    Parameters:
    
    DealOfExistSameTable - 同名表的处理，ReportErrorAfterCheck(前置校验并报错，默认)、ExecuteAfterIgnore(忽略并继续执行)
  - getConflictHandleType
```
public String getConflictHandleType()
```
    Get 冲突处理选项，ReportError(报错，默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
    
    Returns:
    
    ConflictHandleType 冲突处理选项，ReportError(报错，默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
  - setConflictHandleType
```
public void setConflictHandleType(String ConflictHandleType)
```
    Set 冲突处理选项，ReportError(报错，默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
    
    Parameters:
    
    ConflictHandleType - 冲突处理选项，ReportError(报错，默认为该值)、Ignore(忽略)、Cover(覆盖)、ConditionCover(条件覆盖)
  - getAddAdditionalColumn
```
public Boolean getAddAdditionalColumn()
```
    Get 是否添加附加列
    
    Returns:
    
    AddAdditionalColumn 是否添加附加列
  - setAddAdditionalColumn
```
public void setAddAdditionalColumn(Boolean AddAdditionalColumn)
```
    Set 是否添加附加列
    
    Parameters:
    
    AddAdditionalColumn - 是否添加附加列
  - getOpTypes
```
public String[] getOpTypes()
```
    Get 所要同步的DML和DDL的选项，Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步)， PartialDDL(自定义,和DdlOptions一起配合使用)。注意，这里至少需要包含DML中的一种。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    OpTypes 所要同步的DML和DDL的选项，Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步)， PartialDDL(自定义,和DdlOptions一起配合使用)。注意，这里至少需要包含DML中的一种。注意：此字段可能返回 null，表示取不到有效值。
  - setOpTypes
```
public void setOpTypes(String[] OpTypes)
```
    Set 所要同步的DML和DDL的选项，Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步)， PartialDDL(自定义,和DdlOptions一起配合使用)。注意，这里至少需要包含DML中的一种。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    OpTypes - 所要同步的DML和DDL的选项，Insert(插入操作)、Update(更新操作)、Delete(删除操作)、DDL(结构同步)， PartialDDL(自定义,和DdlOptions一起配合使用)。注意，这里至少需要包含DML中的一种。注意：此字段可能返回 null，表示取不到有效值。
  - getConflictHandleOption
```
public ConflictHandleOption getConflictHandleOption()
```
    Get 冲突处理的详细选项，如条件覆盖中的条件行和条件操作
    
    Returns:
    
    ConflictHandleOption 冲突处理的详细选项，如条件覆盖中的条件行和条件操作
  - setConflictHandleOption
```
public void setConflictHandleOption(ConflictHandleOption ConflictHandleOption)
```
    Set 冲突处理的详细选项，如条件覆盖中的条件行和条件操作
    
    Parameters:
    
    ConflictHandleOption - 冲突处理的详细选项，如条件覆盖中的条件行和条件操作
  - getDdlOptions
```
public DdlOption[] getDdlOptions()
```
    Get DDL同步选项，具体描述要同步哪些DDL 注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    DdlOptions DDL同步选项，具体描述要同步哪些DDL 注意：此字段可能返回 null，表示取不到有效值。
  - setDdlOptions
```
public void setDdlOptions(DdlOption[] DdlOptions)
```
    Set DDL同步选项，具体描述要同步哪些DDL 注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    DdlOptions - DDL同步选项，具体描述要同步哪些DDL 注意：此字段可能返回 null，表示取不到有效值。
  - getKafkaOption
```
public KafkaOption getKafkaOption()
```
    Get kafka同步选项
    
    Returns:
    
    KafkaOption kafka同步选项
  - setKafkaOption
```
public void setKafkaOption(KafkaOption KafkaOption)
```
    Set kafka同步选项
    
    Parameters:
    
    KafkaOption - kafka同步选项
  - getRateLimitOption
```
public RateLimitOption getRateLimitOption()
```
    Get 任务限速信息
    
    Returns:
    
    RateLimitOption 任务限速信息
  - setRateLimitOption
```
public void setRateLimitOption(RateLimitOption RateLimitOption)
```
    Set 任务限速信息
    
    Parameters:
    
    RateLimitOption - 任务限速信息
  - getAutoRetryTimeRangeMinutes
```
public Long getAutoRetryTimeRangeMinutes()
```
    Get 自动重试的时间窗口设置
    
    Returns:
    
    AutoRetryTimeRangeMinutes 自动重试的时间窗口设置
  - setAutoRetryTimeRangeMinutes
```
public void setAutoRetryTimeRangeMinutes(Long AutoRetryTimeRangeMinutes)
```
    Set 自动重试的时间窗口设置
    
    Parameters:
    
    AutoRetryTimeRangeMinutes - 自动重试的时间窗口设置
  - getStartPosition
```
public String getStartPosition()
```
    Get 同步到kafka链路指定位点。目前只支持时间格式：2023-12-20T19:24:23+08:00。如果没有指定位点，为空。
    
    Returns:
    
    StartPosition 同步到kafka链路指定位点。目前只支持时间格式：2023-12-20T19:24:23+08:00。如果没有指定位点，为空。
  - setStartPosition
```
public void setStartPosition(String StartPosition)
```
    Set 同步到kafka链路指定位点。目前只支持时间格式：2023-12-20T19:24:23+08:00。如果没有指定位点，为空。
    
    Parameters:
    
    StartPosition - 同步到kafka链路指定位点。目前只支持时间格式：2023-12-20T19:24:23+08:00。如果没有指定位点，为空。
  - getFilterBeginCommit
```
public Boolean getFilterBeginCommit()
```
    Get 同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持
    
    Returns:
    
    FilterBeginCommit 同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持
  - setFilterBeginCommit
```
public void setFilterBeginCommit(Boolean FilterBeginCommit)
```
    Set 同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持
    
    Parameters:
    
    FilterBeginCommit - 同步到kafka链路是否过滤掉begin和commit消息。目前仅mysql2kafka链路支持
  - getFilterCheckpoint
```
public Boolean getFilterCheckpoint()
```
    Get 同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持
    
    Returns:
    
    FilterCheckpoint 同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持
  - setFilterCheckpoint
```
public void setFilterCheckpoint(Boolean FilterCheckpoint)
```
    Set 同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持
    
    Parameters:
    
    FilterCheckpoint - 同步到kafka链路是否过滤掉checkpoint消息。目前仅mysql2kafka链路支持
  - 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.

Class Options

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

Options

Options

Method Detail

getInitType

setInitType

getDealOfExistSameTable

setDealOfExistSameTable

getConflictHandleType

setConflictHandleType

getAddAdditionalColumn

setAddAdditionalColumn

getOpTypes

setOpTypes

getConflictHandleOption

setConflictHandleOption

getDdlOptions

setDdlOptions

getKafkaOption

setKafkaOption

getRateLimitOption

setRateLimitOption

getAutoRetryTimeRangeMinutes

setAutoRetryTimeRangeMinutes

getStartPosition

setStartPosition

getFilterBeginCommit

setFilterBeginCommit

getFilterCheckpoint

setFilterCheckpoint

toMap