Package org.apache.camel.builder.endpoint.dsl

Interface DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
DebeziumMongodbEndpointBuilderFactory
public static interface DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Debezium MongoDB Connector component.

  • Method Details

    • advanced

      default DebeziumMongodbEndpointBuilderFactory.AdvancedDebeziumMongodbEndpointBuilder advanced()

    • additionalProperties

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder additionalProperties(String key, Object value)
      Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&amp;additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • additionalProperties

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder additionalProperties(Map values)
      Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&amp;additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • internalKeyConverter

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder internalKeyConverter(String internalKeyConverter)
      The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer
      Parameters:
      internalKeyConverter - the value to set
      Returns:
      the dsl builder

    • internalValueConverter

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder internalValueConverter(String internalValueConverter)
      The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer
      Parameters:
      internalValueConverter - the value to set
      Returns:
      the dsl builder

    • offsetCommitPolicy

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetCommitPolicy(String offsetCommitPolicy)
      The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      offsetCommitPolicy - the value to set
      Returns:
      the dsl builder

    • offsetCommitTimeoutMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetCommitTimeoutMs(long offsetCommitTimeoutMs)
      Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. The option is a: <code>long</code> type. Default: 5000 Group: consumer
      Parameters:
      offsetCommitTimeoutMs - the value to set
      Returns:
      the dsl builder

    • offsetCommitTimeoutMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetCommitTimeoutMs(String offsetCommitTimeoutMs)
      Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. The option will be converted to a <code>long</code> type. Default: 5000 Group: consumer
      Parameters:
      offsetCommitTimeoutMs - the value to set
      Returns:
      the dsl builder

    • offsetFlushIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetFlushIntervalMs(long offsetFlushIntervalMs)
      Interval at which to try committing offsets. The default is 1 minute. The option is a: <code>long</code> type. Default: 60000 Group: consumer
      Parameters:
      offsetFlushIntervalMs - the value to set
      Returns:
      the dsl builder

    • offsetFlushIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetFlushIntervalMs(String offsetFlushIntervalMs)
      Interval at which to try committing offsets. The default is 1 minute. The option will be converted to a <code>long</code> type. Default: 60000 Group: consumer
      Parameters:
      offsetFlushIntervalMs - the value to set
      Returns:
      the dsl builder

    • offsetStorage

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetStorage(String offsetStorage)
      The name of the Java class that is responsible for persistence of connector offsets. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.storage.FileOffsetBackingStore Group: consumer
      Parameters:
      offsetStorage - the value to set
      Returns:
      the dsl builder

    • offsetStorageFileName

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetStorageFileName(String offsetStorageFileName)
      Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      offsetStorageFileName - the value to set
      Returns:
      the dsl builder

    • offsetStoragePartitions

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetStoragePartitions(int offsetStoragePartitions)
      The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. The option is a: <code>int</code> type. Group: consumer
      Parameters:
      offsetStoragePartitions - the value to set
      Returns:
      the dsl builder

    • offsetStoragePartitions

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetStoragePartitions(String offsetStoragePartitions)
      The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. The option will be converted to a <code>int</code> type. Group: consumer
      Parameters:
      offsetStoragePartitions - the value to set
      Returns:
      the dsl builder

    • offsetStorageReplicationFactor

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetStorageReplicationFactor(int offsetStorageReplicationFactor)
      Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. The option is a: <code>int</code> type. Group: consumer
      Parameters:
      offsetStorageReplicationFactor - the value to set
      Returns:
      the dsl builder

    • offsetStorageReplicationFactor

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetStorageReplicationFactor(String offsetStorageReplicationFactor)
      Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. The option will be converted to a <code>int</code> type. Group: consumer
      Parameters:
      offsetStorageReplicationFactor - the value to set
      Returns:
      the dsl builder

    • offsetStorageTopic

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder offsetStorageTopic(String offsetStorageTopic)
      The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      offsetStorageTopic - the value to set
      Returns:
      the dsl builder

    • captureMode

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder captureMode(String captureMode)
      The method used to capture changes from MongoDB server. Options include: 'change_streams' to capture changes via MongoDB Change Streams, update events do not contain full documents; 'change_streams_update_full' (the default) to capture changes via MongoDB Change Streams, update events contain full documents. The option is a: <code>java.lang.String</code> type. Default: change_streams_update_full Group: mongodb
      Parameters:
      captureMode - the value to set
      Returns:
      the dsl builder

    • collectionExcludeList

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder collectionExcludeList(String collectionExcludeList)
      A comma-separated list of regular expressions that match the collection names for which changes are to be excluded. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      collectionExcludeList - the value to set
      Returns:
      the dsl builder

    • collectionIncludeList

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder collectionIncludeList(String collectionIncludeList)
      A comma-separated list of regular expressions that match the collection names for which changes are to be captured. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      collectionIncludeList - the value to set
      Returns:
      the dsl builder

    • converters

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder converters(String converters)
      Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      converters - the value to set
      Returns:
      the dsl builder

    • cursorMaxAwaitTimeMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder cursorMaxAwaitTimeMs(int cursorMaxAwaitTimeMs)
      The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request. The option is a: <code>int</code> type. Group: mongodb
      Parameters:
      cursorMaxAwaitTimeMs - the value to set
      Returns:
      the dsl builder

    • cursorMaxAwaitTimeMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder cursorMaxAwaitTimeMs(String cursorMaxAwaitTimeMs)
      The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request. The option will be converted to a <code>int</code> type. Group: mongodb
      Parameters:
      cursorMaxAwaitTimeMs - the value to set
      Returns:
      the dsl builder

    • databaseExcludeList

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder databaseExcludeList(String databaseExcludeList)
      A comma-separated list of regular expressions that match the database names for which changes are to be excluded. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      databaseExcludeList - the value to set
      Returns:
      the dsl builder

    • databaseIncludeList

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder databaseIncludeList(String databaseIncludeList)
      A comma-separated list of regular expressions that match the database names for which changes are to be captured. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      databaseIncludeList - the value to set
      Returns:
      the dsl builder

    • errorsMaxRetries

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder errorsMaxRetries(int errorsMaxRetries)
      The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries). The option is a: <code>int</code> type. Default: -1 Group: mongodb
      Parameters:
      errorsMaxRetries - the value to set
      Returns:
      the dsl builder

    • errorsMaxRetries

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder errorsMaxRetries(String errorsMaxRetries)
      The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries). The option will be converted to a <code>int</code> type. Default: -1 Group: mongodb
      Parameters:
      errorsMaxRetries - the value to set
      Returns:
      the dsl builder

    • eventProcessingFailureHandlingMode

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder eventProcessingFailureHandlingMode(String eventProcessingFailureHandlingMode)
      Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped. The option is a: <code>java.lang.String</code> type. Default: fail Group: mongodb
      Parameters:
      eventProcessingFailureHandlingMode - the value to set
      Returns:
      the dsl builder

    • fieldExcludeList

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder fieldExcludeList(String fieldExcludeList)
      A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      fieldExcludeList - the value to set
      Returns:
      the dsl builder

    • fieldRenames

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder fieldRenames(String fieldRenames)
      A comma-separated list of the fully-qualified replacements of fields that should be used to rename fields in change event message values. Fully-qualified replacements for fields are of the form databaseName.collectionName.fieldName.nestedFieldName:newNestedFieldName, where databaseName and collectionName may contain the wildcard () which matches any characters, the colon character (:) is used to determine rename mapping of field. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      fieldRenames - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder heartbeatIntervalMs(int heartbeatIntervalMs)
      Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. The option is a: <code>int</code> type. Default: 0ms Group: mongodb
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder heartbeatIntervalMs(String heartbeatIntervalMs)
      Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. The option will be converted to a <code>int</code> type. Default: 0ms Group: mongodb
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • heartbeatTopicsPrefix

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder heartbeatTopicsPrefix(String heartbeatTopicsPrefix)
      The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. The option is a: <code>java.lang.String</code> type. Default: __debezium-heartbeat Group: mongodb
      Parameters:
      heartbeatTopicsPrefix - the value to set
      Returns:
      the dsl builder

    • maxBatchSize

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder maxBatchSize(int maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048. The option is a: <code>int</code> type. Default: 2048 Group: mongodb
      Parameters:
      maxBatchSize - the value to set
      Returns:
      the dsl builder

    • maxBatchSize

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder maxBatchSize(String maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048. The option will be converted to a <code>int</code> type. Default: 2048 Group: mongodb
      Parameters:
      maxBatchSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSize

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder maxQueueSize(int maxQueueSize)
      Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. The option is a: <code>int</code> type. Default: 8192 Group: mongodb
      Parameters:
      maxQueueSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSize

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder maxQueueSize(String maxQueueSize)
      Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. The option will be converted to a <code>int</code> type. Default: 8192 Group: mongodb
      Parameters:
      maxQueueSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSizeInBytes

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder maxQueueSizeInBytes(long maxQueueSizeInBytes)
      Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled. The option is a: <code>long</code> type. Default: 0 Group: mongodb
      Parameters:
      maxQueueSizeInBytes - the value to set
      Returns:
      the dsl builder

    • maxQueueSizeInBytes

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder maxQueueSizeInBytes(String maxQueueSizeInBytes)
      Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled. The option will be converted to a <code>long</code> type. Default: 0 Group: mongodb
      Parameters:
      maxQueueSizeInBytes - the value to set
      Returns:
      the dsl builder

    • mongodbAuthsource

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbAuthsource(String mongodbAuthsource)
      Database containing user credentials. The option is a: <code>java.lang.String</code> type. Default: admin Group: mongodb
      Parameters:
      mongodbAuthsource - the value to set
      Returns:
      the dsl builder

    • mongodbConnectionMode

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbConnectionMode(String mongodbConnectionMode)
      The method used to connect to MongoDB cluster. Options include: 'replica_set' (the default) to individually connect to each replica set / shard 'sharded' to connect via single connection obtained from connection string. The option is a: <code>java.lang.String</code> type. Default: replica_set Group: mongodb
      Parameters:
      mongodbConnectionMode - the value to set
      Returns:
      the dsl builder

    • mongodbConnectionString

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbConnectionString(String mongodbConnectionString)
      Database connection string. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      mongodbConnectionString - the value to set
      Returns:
      the dsl builder

    • mongodbConnectTimeoutMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbConnectTimeoutMs(int mongodbConnectTimeoutMs)
      The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). The option is a: <code>int</code> type. Default: 10s Group: mongodb
      Parameters:
      mongodbConnectTimeoutMs - the value to set
      Returns:
      the dsl builder

    • mongodbConnectTimeoutMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbConnectTimeoutMs(String mongodbConnectTimeoutMs)
      The connection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). The option will be converted to a <code>int</code> type. Default: 10s Group: mongodb
      Parameters:
      mongodbConnectTimeoutMs - the value to set
      Returns:
      the dsl builder

    • mongodbHeartbeatFrequencyMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbHeartbeatFrequencyMs(int mongodbHeartbeatFrequencyMs)
      The frequency that the cluster monitor attempts to reach each server. Defaults to 10 seconds (10,000 ms). The option is a: <code>int</code> type. Default: 10s Group: mongodb
      Parameters:
      mongodbHeartbeatFrequencyMs - the value to set
      Returns:
      the dsl builder

    • mongodbHeartbeatFrequencyMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbHeartbeatFrequencyMs(String mongodbHeartbeatFrequencyMs)
      The frequency that the cluster monitor attempts to reach each server. Defaults to 10 seconds (10,000 ms). The option will be converted to a <code>int</code> type. Default: 10s Group: mongodb
      Parameters:
      mongodbHeartbeatFrequencyMs - the value to set
      Returns:
      the dsl builder

    • mongodbPassword

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbPassword(String mongodbPassword)
      Password to be used when connecting to MongoDB, if necessary. The option is a: <code>java.lang.String</code> type. Required: true Group: mongodb
      Parameters:
      mongodbPassword - the value to set
      Returns:
      the dsl builder

    • mongodbPollIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbPollIntervalMs(long mongodbPollIntervalMs)
      Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms). The option is a: <code>long</code> type. Default: 30s Group: mongodb
      Parameters:
      mongodbPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • mongodbPollIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbPollIntervalMs(String mongodbPollIntervalMs)
      Interval for looking for new, removed, or changed replica sets, given in milliseconds. Defaults to 30 seconds (30,000 ms). The option will be converted to a <code>long</code> type. Default: 30s Group: mongodb
      Parameters:
      mongodbPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • mongodbServerSelectionTimeoutMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbServerSelectionTimeoutMs(int mongodbServerSelectionTimeoutMs)
      The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). The option is a: <code>int</code> type. Default: 30s Group: mongodb
      Parameters:
      mongodbServerSelectionTimeoutMs - the value to set
      Returns:
      the dsl builder

    • mongodbServerSelectionTimeoutMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbServerSelectionTimeoutMs(String mongodbServerSelectionTimeoutMs)
      The server selection timeout, given in milliseconds. Defaults to 10 seconds (10,000 ms). The option will be converted to a <code>int</code> type. Default: 30s Group: mongodb
      Parameters:
      mongodbServerSelectionTimeoutMs - the value to set
      Returns:
      the dsl builder

    • mongodbSocketTimeoutMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbSocketTimeoutMs(int mongodbSocketTimeoutMs)
      The socket timeout, given in milliseconds. Defaults to 0 ms. The option is a: <code>int</code> type. Default: 0ms Group: mongodb
      Parameters:
      mongodbSocketTimeoutMs - the value to set
      Returns:
      the dsl builder

    • mongodbSocketTimeoutMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbSocketTimeoutMs(String mongodbSocketTimeoutMs)
      The socket timeout, given in milliseconds. Defaults to 0 ms. The option will be converted to a <code>int</code> type. Default: 0ms Group: mongodb
      Parameters:
      mongodbSocketTimeoutMs - the value to set
      Returns:
      the dsl builder

    • mongodbSslEnabled

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbSslEnabled(boolean mongodbSslEnabled)
      Should connector use SSL to connect to MongoDB instances. The option is a: <code>boolean</code> type. Default: false Group: mongodb
      Parameters:
      mongodbSslEnabled - the value to set
      Returns:
      the dsl builder

    • mongodbSslEnabled

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbSslEnabled(String mongodbSslEnabled)
      Should connector use SSL to connect to MongoDB instances. The option will be converted to a <code>boolean</code> type. Default: false Group: mongodb
      Parameters:
      mongodbSslEnabled - the value to set
      Returns:
      the dsl builder

    • mongodbSslInvalidHostnameAllowed

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbSslInvalidHostnameAllowed(boolean mongodbSslInvalidHostnameAllowed)
      Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks. The option is a: <code>boolean</code> type. Default: false Group: mongodb
      Parameters:
      mongodbSslInvalidHostnameAllowed - the value to set
      Returns:
      the dsl builder

    • mongodbSslInvalidHostnameAllowed

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbSslInvalidHostnameAllowed(String mongodbSslInvalidHostnameAllowed)
      Whether invalid host names are allowed when using SSL. If true the connection will not prevent man-in-the-middle attacks. The option will be converted to a <code>boolean</code> type. Default: false Group: mongodb
      Parameters:
      mongodbSslInvalidHostnameAllowed - the value to set
      Returns:
      the dsl builder

    • mongodbUser

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbUser(String mongodbUser)
      Database user for connecting to MongoDB, if necessary. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      mongodbUser - the value to set
      Returns:
      the dsl builder

    • notificationEnabledChannels

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder notificationEnabledChannels(String notificationEnabledChannels)
      List of notification channels names that are enabled. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      notificationEnabledChannels - the value to set
      Returns:
      the dsl builder

    • notificationSinkTopicName

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder notificationSinkTopicName(String notificationSinkTopicName)
      The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      notificationSinkTopicName - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder pollIntervalMs(long pollIntervalMs)
      Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. The option is a: <code>long</code> type. Default: 500ms Group: mongodb
      Parameters:
      pollIntervalMs - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder pollIntervalMs(String pollIntervalMs)
      Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. The option will be converted to a <code>long</code> type. Default: 500ms Group: mongodb
      Parameters:
      pollIntervalMs - the value to set
      Returns:
      the dsl builder

    • provideTransactionMetadata

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder provideTransactionMetadata(boolean provideTransactionMetadata)
      Enables transaction metadata extraction together with event counting. The option is a: <code>boolean</code> type. Default: false Group: mongodb
      Parameters:
      provideTransactionMetadata - the value to set
      Returns:
      the dsl builder

    • provideTransactionMetadata

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder provideTransactionMetadata(String provideTransactionMetadata)
      Enables transaction metadata extraction together with event counting. The option will be converted to a <code>boolean</code> type. Default: false Group: mongodb
      Parameters:
      provideTransactionMetadata - the value to set
      Returns:
      the dsl builder

    • queryFetchSize

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder queryFetchSize(int queryFetchSize)
      The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size. The option is a: <code>int</code> type. Default: 0 Group: mongodb
      Parameters:
      queryFetchSize - the value to set
      Returns:
      the dsl builder

    • queryFetchSize

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder queryFetchSize(String queryFetchSize)
      The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size. The option will be converted to a <code>int</code> type. Default: 0 Group: mongodb
      Parameters:
      queryFetchSize - the value to set
      Returns:
      the dsl builder

    • retriableRestartConnectorWaitMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder retriableRestartConnectorWaitMs(long retriableRestartConnectorWaitMs)
      Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option is a: <code>long</code> type. Default: 10s Group: mongodb
      Parameters:
      retriableRestartConnectorWaitMs - the value to set
      Returns:
      the dsl builder

    • retriableRestartConnectorWaitMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder retriableRestartConnectorWaitMs(String retriableRestartConnectorWaitMs)
      Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option will be converted to a <code>long</code> type. Default: 10s Group: mongodb
      Parameters:
      retriableRestartConnectorWaitMs - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalFileFilename

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder schemaHistoryInternalFileFilename(String schemaHistoryInternalFileFilename)
      The path to the file that will be used to record the database schema history. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      schemaHistoryInternalFileFilename - the value to set
      Returns:
      the dsl builder

    • schemaNameAdjustmentMode

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder schemaNameAdjustmentMode(String schemaNameAdjustmentMode)
      Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default). The option is a: <code>java.lang.String</code> type. Default: none Group: mongodb
      Parameters:
      schemaNameAdjustmentMode - the value to set
      Returns:
      the dsl builder

    • signalDataCollection

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder signalDataCollection(String signalDataCollection)
      The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      signalDataCollection - the value to set
      Returns:
      the dsl builder

    • signalEnabledChannels

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder signalEnabledChannels(String signalEnabledChannels)
      List of channels names that are enabled. Source channel is enabled by default. The option is a: <code>java.lang.String</code> type. Default: source Group: mongodb
      Parameters:
      signalEnabledChannels - the value to set
      Returns:
      the dsl builder

    • signalPollIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder signalPollIntervalMs(long signalPollIntervalMs)
      Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option is a: <code>long</code> type. Default: 5s Group: mongodb
      Parameters:
      signalPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • signalPollIntervalMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder signalPollIntervalMs(String signalPollIntervalMs)
      Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option will be converted to a <code>long</code> type. Default: 5s Group: mongodb
      Parameters:
      signalPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • skippedOperations

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder skippedOperations(String skippedOperations)
      The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped. The option is a: <code>java.lang.String</code> type. Default: t Group: mongodb
      Parameters:
      skippedOperations - the value to set
      Returns:
      the dsl builder

    • snapshotCollectionFilterOverrides

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotCollectionFilterOverrides(String snapshotCollectionFilterOverrides)
      This property contains a comma-separated list of ., for which the initial snapshot may be a subset of data present in the data source. The subset would be defined by mongodb filter query specified as value for property snapshot.collection.filter.override.. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      snapshotCollectionFilterOverrides - the value to set
      Returns:
      the dsl builder

    • snapshotDelayMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotDelayMs(long snapshotDelayMs)
      A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. The option is a: <code>long</code> type. Default: 0ms Group: mongodb
      Parameters:
      snapshotDelayMs - the value to set
      Returns:
      the dsl builder

    • snapshotDelayMs

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotDelayMs(String snapshotDelayMs)
      A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. The option will be converted to a <code>long</code> type. Default: 0ms Group: mongodb
      Parameters:
      snapshotDelayMs - the value to set
      Returns:
      the dsl builder

    • snapshotFetchSize

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotFetchSize(int snapshotFetchSize)
      The maximum number of records that should be loaded into memory while performing a snapshot. The option is a: <code>int</code> type. Group: mongodb
      Parameters:
      snapshotFetchSize - the value to set
      Returns:
      the dsl builder

    • snapshotFetchSize

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotFetchSize(String snapshotFetchSize)
      The maximum number of records that should be loaded into memory while performing a snapshot. The option will be converted to a <code>int</code> type. Group: mongodb
      Parameters:
      snapshotFetchSize - the value to set
      Returns:
      the dsl builder

    • snapshotIncludeCollectionList

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotIncludeCollectionList(String snapshotIncludeCollectionList)
      This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector. The option is a: <code>java.lang.String</code> type. Group: mongodb
      Parameters:
      snapshotIncludeCollectionList - the value to set
      Returns:
      the dsl builder

    • snapshotMaxThreads

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotMaxThreads(int snapshotMaxThreads)
      The maximum number of threads used to perform the snapshot. Defaults to 1. The option is a: <code>int</code> type. Default: 1 Group: mongodb
      Parameters:
      snapshotMaxThreads - the value to set
      Returns:
      the dsl builder

    • snapshotMaxThreads

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotMaxThreads(String snapshotMaxThreads)
      The maximum number of threads used to perform the snapshot. Defaults to 1. The option will be converted to a <code>int</code> type. Default: 1 Group: mongodb
      Parameters:
      snapshotMaxThreads - the value to set
      Returns:
      the dsl builder

    • snapshotMode

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder snapshotMode(String snapshotMode)
      The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the oplog. 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the oplog. The option is a: <code>java.lang.String</code> type. Default: initial Group: mongodb
      Parameters:
      snapshotMode - the value to set
      Returns:
      the dsl builder

    • sourceinfoStructMaker

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder sourceinfoStructMaker(String sourceinfoStructMaker)
      The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct. The option is a: <code>java.lang.String</code> type. Default: io.debezium.connector.mongodb.MongoDbSourceInfoStructMaker Group: mongodb
      Parameters:
      sourceinfoStructMaker - the value to set
      Returns:
      the dsl builder

    • tombstonesOnDelete

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder tombstonesOnDelete(boolean tombstonesOnDelete)
      Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. The option is a: <code>boolean</code> type. Default: false Group: mongodb
      Parameters:
      tombstonesOnDelete - the value to set
      Returns:
      the dsl builder

    • tombstonesOnDelete

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder tombstonesOnDelete(String tombstonesOnDelete)
      Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. The option will be converted to a <code>boolean</code> type. Default: false Group: mongodb
      Parameters:
      tombstonesOnDelete - the value to set
      Returns:
      the dsl builder

    • topicNamingStrategy

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder topicNamingStrategy(String topicNamingStrategy)
      The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc. The option is a: <code>java.lang.String</code> type. Default: io.debezium.schema.SchemaTopicNamingStrategy Group: mongodb
      Parameters:
      topicNamingStrategy - the value to set
      Returns:
      the dsl builder

    • topicPrefix

      default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder topicPrefix(String topicPrefix)
      Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted. The option is a: <code>java.lang.String</code> type. Required: true Group: mongodb
      Parameters:
      topicPrefix - the value to set
      Returns:
      the dsl builder