Package io.debezium.connector.sqlserver

Enum SqlServerConnectorConfig.SnapshotMode

java.lang.Object

java.lang.Enum<SqlServerConnectorConfig.SnapshotMode>

io.debezium.connector.sqlserver.SqlServerConnectorConfig.SnapshotMode

All Implemented Interfaces:

EnumeratedValue, Serializable, Comparable<SqlServerConnectorConfig.SnapshotMode>

Enclosing class:

SqlServerConnectorConfig

public static enum SqlServerConnectorConfig.SnapshotMode
extends Enum<SqlServerConnectorConfig.SnapshotMode>
implements EnumeratedValue

The set of predefined SnapshotMode options or aliases.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INITIAL	Perform a snapshot of data and schema upon initial startup of a connector.
INITIAL_ONLY	Perform a snapshot of data and schema upon initial startup of a connector but does not transition to streaming.
SCHEMA_ONLY	Perform a snapshot of the schema but no data upon initial startup of a connector.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	includeData
private final String	value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SnapshotMode(String value, boolean includeData)

Method Summary

Modifier and Type	Method	Description
String	getValue()
boolean	includeData()	Whether this snapshotting mode should include the actual data or just the schema of captured tables.
static SqlServerConnectorConfig.SnapshotMode	parse(String value)	Determine if the supplied value is one of the predefined options.
static SqlServerConnectorConfig.SnapshotMode	parse(String value, String defaultValue)	Determine if the supplied value is one of the predefined options.
static SqlServerConnectorConfig.SnapshotMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SqlServerConnectorConfig.SnapshotMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INITIAL

public static final SqlServerConnectorConfig.SnapshotMode INITIAL

Perform a snapshot of data and schema upon initial startup of a connector.

INITIAL_ONLY

public static final SqlServerConnectorConfig.SnapshotMode INITIAL_ONLY

Perform a snapshot of data and schema upon initial startup of a connector but does not transition to streaming.

SCHEMA_ONLY

public static final SqlServerConnectorConfig.SnapshotMode SCHEMA_ONLY

Perform a snapshot of the schema but no data upon initial startup of a connector.

Field Details

value

private final String value

includeData

private final boolean includeData

Constructor Details

SnapshotMode

private SnapshotMode(String value,
 boolean includeData)

Method Details

values

public static SqlServerConnectorConfig.SnapshotMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SqlServerConnectorConfig.SnapshotMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Specified by:

getValue in interface EnumeratedValue

includeData

public boolean includeData()

Whether this snapshotting mode should include the actual data or just the schema of captured tables.

parse

public static SqlServerConnectorConfig.SnapshotMode parse(String value)

Determine if the supplied value is one of the predefined options.

Parameters:

value - the configuration property value; may not be null

Returns:

the matching option, or null if no match is found

parse

public static SqlServerConnectorConfig.SnapshotMode parse(String value,
 String defaultValue)

Determine if the supplied value is one of the predefined options.

Parameters:

value - the configuration property value; may not be null

defaultValue - the default value; may be null

Returns:

the matching option, or null if no match is found and the non-null default is invalid