Package io.debezium.connector.mongodb

Enum MongoDbConnectorConfig.CaptureMode

java.lang.Object
java.lang.Enum<MongoDbConnectorConfig.CaptureMode>
io.debezium.connector.mongodb.MongoDbConnectorConfig.CaptureMode
All Implemented Interfaces:
EnumeratedValue, Serializable, Comparable<MongoDbConnectorConfig.CaptureMode>
Enclosing class:
MongoDbConnectorConfig
public static enum MongoDbConnectorConfig.CaptureMode extends Enum<MongoDbConnectorConfig.CaptureMode> implements EnumeratedValue
The set of different ways how connector can capture changes.

  • Enum Constant Details

    • CHANGE_STREAMS

      public static final MongoDbConnectorConfig.CaptureMode CHANGE_STREAMS
      Change capture based on MongoDB Change Streams support.

    • CHANGE_STREAMS_UPDATE_FULL

      public static final MongoDbConnectorConfig.CaptureMode CHANGE_STREAMS_UPDATE_FULL
      Change capture based on MongoDB change Streams support. The update message will contain the full document.

    • CHANGE_STREAMS_WITH_PRE_IMAGE

      public static final MongoDbConnectorConfig.CaptureMode CHANGE_STREAMS_WITH_PRE_IMAGE
      Change capture based on MongoDB Change Streams support with pre-image. When applicable, the change event will include the full document before change.

    • CHANGE_STREAMS_UPDATE_FULL_WITH_PRE_IMAGE

      public static final MongoDbConnectorConfig.CaptureMode CHANGE_STREAMS_UPDATE_FULL_WITH_PRE_IMAGE
      Change capture based on MongoDB change Streams support with pre-image. When applicable, the change event will include the full document before change. The update message will contain the full document.

  • Field Details

    • value

      private final String value

    • changeStreams

      private final boolean changeStreams

    • fullUpdate

      private final boolean fullUpdate

    • includePreImage

      private final boolean includePreImage

  • Constructor Details

    • CaptureMode

      private CaptureMode(String value, boolean changeStreams, boolean fullUpdate, boolean includePreImage)

  • Method Details

    • values

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

    • isFullUpdate

      public boolean isFullUpdate()

    • isIncludePreImage

      public boolean isIncludePreImage()