Package io.debezium.connector.mongodb

Enum MongoDbConnectorConfig.SnapshotMode

java.lang.Object

java.lang.Enum<MongoDbConnectorConfig.SnapshotMode>

io.debezium.connector.mongodb.MongoDbConnectorConfig.SnapshotMode

All Implemented Interfaces:

EnumeratedValue, Serializable, Comparable<MongoDbConnectorConfig.SnapshotMode>

Enclosing class:

MongoDbConnectorConfig

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

The set of predefined SnapshotMode options or aliases.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Performs a snapshot of data and schema upon each connector start.
CONFIGURATION_BASED	Allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'.
CUSTOM	Inject a custom snapshotter, which allows for more control over snapshots.
INITIAL	Perform a snapshot only upon initial startup of a connector.
INITIAL_ONLY	Perform a snapshot and then stop before attempting to receive any logical changes.
NEVER	Deprecated. to be removed in Debezium 3.0, replaced by {NO_DATA}
NO_DATA	Never perform a snapshot and only receive new data changes.
WHEN_NEEDED	Perform a snapshot when it is needed.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SnapshotMode(String value)

Method Summary

Modifier and Type	Method	Description
String	getValue()
static MongoDbConnectorConfig.SnapshotMode	parse(String value)	Determine if the supplied value is one of the predefined options.
static MongoDbConnectorConfig.SnapshotMode	parse(String value, String defaultValue)	Determine if the supplied value is one of the predefined options.
static MongoDbConnectorConfig.SnapshotMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MongoDbConnectorConfig.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

ALWAYS

public static final MongoDbConnectorConfig.SnapshotMode ALWAYS

Performs a snapshot of data and schema upon each connector start.

INITIAL

public static final MongoDbConnectorConfig.SnapshotMode INITIAL

Perform a snapshot only upon initial startup of a connector.

NEVER

public static final MongoDbConnectorConfig.SnapshotMode NEVER

Deprecated.

to be removed in Debezium 3.0, replaced by {NO_DATA}

Never perform a snapshot and only receive new data changes.

NO_DATA

public static final MongoDbConnectorConfig.SnapshotMode NO_DATA

Never perform a snapshot and only receive new data changes.

INITIAL_ONLY

public static final MongoDbConnectorConfig.SnapshotMode INITIAL_ONLY

Perform a snapshot and then stop before attempting to receive any logical changes.

WHEN_NEEDED

public static final MongoDbConnectorConfig.SnapshotMode WHEN_NEEDED

Perform a snapshot when it is needed.

CONFIGURATION_BASED

public static final MongoDbConnectorConfig.SnapshotMode CONFIGURATION_BASED

Allows control over snapshots by setting connectors properties prefixed with 'snapshot.mode.configuration.based'.

CUSTOM

public static final MongoDbConnectorConfig.SnapshotMode CUSTOM

Inject a custom snapshotter, which allows for more control over snapshots.

Field Details

value

private final String value

Constructor Details

SnapshotMode

private SnapshotMode(String value)

Method Details

values

public static MongoDbConnectorConfig.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 MongoDbConnectorConfig.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

parse

public static MongoDbConnectorConfig.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 MongoDbConnectorConfig.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