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 Detail

      • 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: 'oplog' to capture changes from the oplog; '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

      • connectBackoffInitialDelayMs

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder connectBackoffInitialDelayMs​(long connectBackoffInitialDelayMs)
        The initial delay when trying to reconnect to a primary after a connection cannot be made or when no primary is available, given in milliseconds. Defaults to 1 second (1,000 ms). The option is a: <code>long</code> type. Default: 1s Group: mongodb
        Parameters:
        connectBackoffInitialDelayMs - the value to set
        Returns:
        the dsl builder

      • connectBackoffInitialDelayMs

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder connectBackoffInitialDelayMs​(String connectBackoffInitialDelayMs)
        The initial delay when trying to reconnect to a primary after a connection cannot be made or when no primary is available, given in milliseconds. Defaults to 1 second (1,000 ms). The option will be converted to a <code>long</code> type. Default: 1s Group: mongodb
        Parameters:
        connectBackoffInitialDelayMs - the value to set
        Returns:
        the dsl builder

      • connectBackoffMaxDelayMs

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder connectBackoffMaxDelayMs​(long connectBackoffMaxDelayMs)
        The maximum delay when trying to reconnect to a primary after a connection cannot be made or when no primary is available, given in milliseconds. Defaults to 120 second (120,000 ms). The option is a: <code>long</code> type. Default: 2m Group: mongodb
        Parameters:
        connectBackoffMaxDelayMs - the value to set
        Returns:
        the dsl builder

      • connectBackoffMaxDelayMs

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder connectBackoffMaxDelayMs​(String connectBackoffMaxDelayMs)
        The maximum delay when trying to reconnect to a primary after a connection cannot be made or when no primary is available, given in milliseconds. Defaults to 120 second (120,000 ms). The option will be converted to a <code>long</code> type. Default: 2m Group: mongodb
        Parameters:
        connectBackoffMaxDelayMs - the value to set
        Returns:
        the dsl builder

      • connectMaxAttempts

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder connectMaxAttempts​(int connectMaxAttempts)
        Maximum number of failed connection attempts to a replica set primary before an exception occurs and task is aborted. Defaults to 16, which with the defaults for 'connect.backoff.initial.delay.ms' and 'connect.backoff.max.delay.ms' results in just over 20 minutes of attempts before failing. The option is a: <code>int</code> type. Default: 16 Group: mongodb
        Parameters:
        connectMaxAttempts - the value to set
        Returns:
        the dsl builder

      • connectMaxAttempts

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder connectMaxAttempts​(String connectMaxAttempts)
        Maximum number of failed connection attempts to a replica set primary before an exception occurs and task is aborted. Defaults to 16, which with the defaults for 'connect.backoff.initial.delay.ms' and 'connect.backoff.max.delay.ms' results in just over 20 minutes of attempts before failing. The option will be converted to a <code>int</code> type. Default: 16 Group: mongodb
        Parameters:
        connectMaxAttempts - 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

      • databaseHistoryFileFilename

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder databaseHistoryFileFilename​(String databaseHistoryFileFilename)
        The path to the file that will be used to record the database history. The option is a: <code>java.lang.String</code> type. Group: mongodb
        Parameters:
        databaseHistoryFileFilename - 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

      • 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

      • 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

      • 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

      • mongodbHosts

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbHosts​(String mongodbHosts)
        The hostname and port pairs (in the form 'host' or 'host:port') of the MongoDB server(s) in the replica set. The option is a: <code>java.lang.String</code> type. Group: mongodb
        Parameters:
        mongodbHosts - the value to set
        Returns:
        the dsl builder

      • mongodbMembersAutoDiscover

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbMembersAutoDiscover​(boolean mongodbMembersAutoDiscover)
        Specifies whether the addresses in 'hosts' are seeds that should be used to discover all members of the cluster or replica set ('true'), or whether the address(es) in 'hosts' should be used as is ('false'). The default is 'true'. The option is a: <code>boolean</code> type. Default: true Group: mongodb
        Parameters:
        mongodbMembersAutoDiscover - the value to set
        Returns:
        the dsl builder

      • mongodbMembersAutoDiscover

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbMembersAutoDiscover​(String mongodbMembersAutoDiscover)
        Specifies whether the addresses in 'hosts' are seeds that should be used to discover all members of the cluster or replica set ('true'), or whether the address(es) in 'hosts' should be used as is ('false'). The default is 'true'. The option will be converted to a <code>boolean</code> type. Default: true Group: mongodb
        Parameters:
        mongodbMembersAutoDiscover - the value to set
        Returns:
        the dsl builder

      • mongodbName

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbName​(String mongodbName)
        Unique name that identifies the MongoDB replica set or cluster and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct MongoDB installation should have a separate namespace and monitored by at most one Debezium connector. The option is a: <code>java.lang.String</code> type. Required: true Group: mongodb
        Parameters:
        mongodbName - 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

      • 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

      • 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

      • sanitizeFieldNames

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder sanitizeFieldNames​(boolean sanitizeFieldNames)
        Whether field names will be sanitized to Avro naming conventions. The option is a: <code>boolean</code> type. Default: false Group: mongodb
        Parameters:
        sanitizeFieldNames - the value to set
        Returns:
        the dsl builder

      • sanitizeFieldNames

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder sanitizeFieldNames​(String sanitizeFieldNames)
        Whether field names will be sanitized to Avro naming conventions. The option will be converted to a <code>boolean</code> type. Default: false Group: mongodb
        Parameters:
        sanitizeFieldNames - 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 (default)'none' does not apply any adjustment. The option is a: <code>java.lang.String</code> type. Default: avro 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

      • 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, no operations will be skipped. The option is a: <code>java.lang.String</code> type. 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. Options include: 'initial' (the default) to specify the connector should always perform an initial sync when required; 'never' to specify the connector should never perform an initial sync. The option is a: <code>java.lang.String</code> type. Default: initial Group: mongodb
        Parameters:
        snapshotMode - the value to set
        Returns:
        the dsl builder

      • sourceStructVersion

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder sourceStructVersion​(String sourceStructVersion)
        A version of the format of the publicly visible source part in the message. The option is a: <code>java.lang.String</code> type. Default: v2 Group: mongodb
        Parameters:
        sourceStructVersion - 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 subsquenttombstone 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 subsquenttombstone 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

      • transactionTopic

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder transactionTopic​(String transactionTopic)
        The name of the transaction metadata topic. The placeholder ${database.server.name} can be used for referring to the connector's logical name; defaults to ${database.server.name}.transaction. The option is a: <code>java.lang.String</code> type. Default: ${database.server.name}.transaction Group: mongodb
        Parameters:
        transactionTopic - the value to set
        Returns:
        the dsl builder