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

Interface DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    Enclosing interface:
    DebeziumDb2EndpointBuilderFactory
    public static interface DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint for the Debezium DB2 Connector component.

    • Method Detail

      • additionalProperties

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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 DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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

      • columnBlacklist

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder columnBlacklist​(String columnBlacklist)
        Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead). The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        columnBlacklist - the value to set
        Returns:
        the dsl builder

      • columnExcludeList

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder columnExcludeList​(String columnExcludeList)
        Regular expressions matching columns to exclude from change events. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        columnExcludeList - the value to set
        Returns:
        the dsl builder

      • columnIncludeList

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder columnIncludeList​(String columnIncludeList)
        Regular expressions matching columns to include in change events. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        columnIncludeList - the value to set
        Returns:
        the dsl builder

      • columnPropagateSourceType

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder columnPropagateSourceType​(String columnPropagateSourceType)
        A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        columnPropagateSourceType - the value to set
        Returns:
        the dsl builder

      • columnWhitelist

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder columnWhitelist​(String columnWhitelist)
        Regular expressions matching columns to include in change events (deprecated, use column.include.list instead). The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        columnWhitelist - the value to set
        Returns:
        the dsl builder

      • converters

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        converters - the value to set
        Returns:
        the dsl builder

      • databaseDbname

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseDbname​(String databaseDbname)
        The name of the database from which the connector should capture changes. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        databaseDbname - the value to set
        Returns:
        the dsl builder

      • databaseHistory

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistory​(String databaseHistory)
        The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. The option is a: <code>java.lang.String</code> type. Default: io.debezium.relational.history.KafkaDatabaseHistory Group: db2
        Parameters:
        databaseHistory - the value to set
        Returns:
        the dsl builder

      • databaseHistoryFileFilename

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        databaseHistoryFileFilename - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaBootstrapServers

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryKafkaBootstrapServers​(String databaseHistoryKafkaBootstrapServers)
        A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        databaseHistoryKafkaBootstrapServers - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaQueryTimeoutMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryKafkaQueryTimeoutMs​(long databaseHistoryKafkaQueryTimeoutMs)
        The number of milliseconds to wait while fetching cluster information using Kafka admin client. The option is a: <code>long</code> type. Default: 3s Group: db2
        Parameters:
        databaseHistoryKafkaQueryTimeoutMs - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaQueryTimeoutMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryKafkaQueryTimeoutMs​(String databaseHistoryKafkaQueryTimeoutMs)
        The number of milliseconds to wait while fetching cluster information using Kafka admin client. The option will be converted to a <code>long</code> type. Default: 3s Group: db2
        Parameters:
        databaseHistoryKafkaQueryTimeoutMs - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaRecoveryAttempts

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryKafkaRecoveryAttempts​(int databaseHistoryKafkaRecoveryAttempts)
        The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). The option is a: <code>int</code> type. Default: 100 Group: db2
        Parameters:
        databaseHistoryKafkaRecoveryAttempts - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaRecoveryAttempts

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryKafkaRecoveryAttempts​(String databaseHistoryKafkaRecoveryAttempts)
        The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). The option will be converted to a <code>int</code> type. Default: 100 Group: db2
        Parameters:
        databaseHistoryKafkaRecoveryAttempts - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaRecoveryPollIntervalMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryKafkaRecoveryPollIntervalMs​(int databaseHistoryKafkaRecoveryPollIntervalMs)
        The number of milliseconds to wait while polling for persisted data during recovery. The option is a: <code>int</code> type. Default: 100ms Group: db2
        Parameters:
        databaseHistoryKafkaRecoveryPollIntervalMs - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaRecoveryPollIntervalMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryKafkaRecoveryPollIntervalMs​(String databaseHistoryKafkaRecoveryPollIntervalMs)
        The number of milliseconds to wait while polling for persisted data during recovery. The option will be converted to a <code>int</code> type. Default: 100ms Group: db2
        Parameters:
        databaseHistoryKafkaRecoveryPollIntervalMs - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaTopic

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryKafkaTopic​(String databaseHistoryKafkaTopic)
        The name of the topic for the database schema history. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        databaseHistoryKafkaTopic - the value to set
        Returns:
        the dsl builder

      • databaseHistorySkipUnparseableDdl

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistorySkipUnparseableDdl​(boolean databaseHistorySkipUnparseableDdl)
        Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes. The option is a: <code>boolean</code> type. Default: false Group: db2
        Parameters:
        databaseHistorySkipUnparseableDdl - the value to set
        Returns:
        the dsl builder

      • databaseHistorySkipUnparseableDdl

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistorySkipUnparseableDdl​(String databaseHistorySkipUnparseableDdl)
        Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes. The option will be converted to a <code>boolean</code> type. Default: false Group: db2
        Parameters:
        databaseHistorySkipUnparseableDdl - the value to set
        Returns:
        the dsl builder

      • databaseHistoryStoreOnlyCapturedTablesDdl

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryStoreOnlyCapturedTablesDdl​(boolean databaseHistoryStoreOnlyCapturedTablesDdl)
        Controls what DDL will Debezium store in database history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored. The option is a: <code>boolean</code> type. Default: false Group: db2
        Parameters:
        databaseHistoryStoreOnlyCapturedTablesDdl - the value to set
        Returns:
        the dsl builder

      • databaseHistoryStoreOnlyCapturedTablesDdl

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryStoreOnlyCapturedTablesDdl​(String databaseHistoryStoreOnlyCapturedTablesDdl)
        Controls what DDL will Debezium store in database history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored. The option will be converted to a <code>boolean</code> type. Default: false Group: db2
        Parameters:
        databaseHistoryStoreOnlyCapturedTablesDdl - the value to set
        Returns:
        the dsl builder

      • databaseHistoryStoreOnlyMonitoredTablesDdl

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryStoreOnlyMonitoredTablesDdl​(boolean databaseHistoryStoreOnlyMonitoredTablesDdl)
        Controls what DDL will Debezium store in database history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a monitored table will be stored (deprecated, use database.history.store.only.captured.tables.ddl instead). The option is a: <code>boolean</code> type. Default: false Group: db2
        Parameters:
        databaseHistoryStoreOnlyMonitoredTablesDdl - the value to set
        Returns:
        the dsl builder

      • databaseHistoryStoreOnlyMonitoredTablesDdl

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHistoryStoreOnlyMonitoredTablesDdl​(String databaseHistoryStoreOnlyMonitoredTablesDdl)
        Controls what DDL will Debezium store in database history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a monitored table will be stored (deprecated, use database.history.store.only.captured.tables.ddl instead). The option will be converted to a <code>boolean</code> type. Default: false Group: db2
        Parameters:
        databaseHistoryStoreOnlyMonitoredTablesDdl - the value to set
        Returns:
        the dsl builder

      • databaseHostname

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseHostname​(String databaseHostname)
        Resolvable hostname or IP address of the database server. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        databaseHostname - the value to set
        Returns:
        the dsl builder

      • databasePassword

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databasePassword​(String databasePassword)
        Password of the database user to be used when connecting to the database. The option is a: <code>java.lang.String</code> type. Required: true Group: db2
        Parameters:
        databasePassword - the value to set
        Returns:
        the dsl builder

      • databaseServerName

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder databaseServerName​(String databaseServerName)
        Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. The option is a: <code>java.lang.String</code> type. Required: true Group: db2
        Parameters:
        databaseServerName - the value to set
        Returns:
        the dsl builder

      • datatypePropagateSourceType

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder datatypePropagateSourceType​(String datatypePropagateSourceType)
        A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        datatypePropagateSourceType - the value to set
        Returns:
        the dsl builder

      • decimalHandlingMode

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder decimalHandlingMode​(String decimalHandlingMode)
        Specify how DECIMAL and NUMERIC columns should be represented in change events, including:'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers. The option is a: <code>java.lang.String</code> type. Default: precise Group: db2
        Parameters:
        decimalHandlingMode - the value to set
        Returns:
        the dsl builder

      • eventProcessingFailureHandlingMode

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        eventProcessingFailureHandlingMode - the value to set
        Returns:
        the dsl builder

      • heartbeatIntervalMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        heartbeatIntervalMs - the value to set
        Returns:
        the dsl builder

      • heartbeatIntervalMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        heartbeatIntervalMs - the value to set
        Returns:
        the dsl builder

      • heartbeatTopicsPrefix

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        heartbeatTopicsPrefix - the value to set
        Returns:
        the dsl builder

      • includeSchemaChanges

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder includeSchemaChanges​(boolean includeSchemaChanges)
        Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. The option is a: <code>boolean</code> type. Default: true Group: db2
        Parameters:
        includeSchemaChanges - the value to set
        Returns:
        the dsl builder

      • includeSchemaChanges

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder includeSchemaChanges​(String includeSchemaChanges)
        Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. The option will be converted to a <code>boolean</code> type. Default: true Group: db2
        Parameters:
        includeSchemaChanges - the value to set
        Returns:
        the dsl builder

      • incrementalSnapshotChunkSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder incrementalSnapshotChunkSize​(int incrementalSnapshotChunkSize)
        The maximum size of chunk for incremental snapshotting. The option is a: <code>int</code> type. Default: 1024 Group: db2
        Parameters:
        incrementalSnapshotChunkSize - the value to set
        Returns:
        the dsl builder

      • incrementalSnapshotChunkSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder incrementalSnapshotChunkSize​(String incrementalSnapshotChunkSize)
        The maximum size of chunk for incremental snapshotting. The option will be converted to a <code>int</code> type. Default: 1024 Group: db2
        Parameters:
        incrementalSnapshotChunkSize - the value to set
        Returns:
        the dsl builder

      • maxBatchSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        maxBatchSize - the value to set
        Returns:
        the dsl builder

      • maxBatchSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        maxBatchSize - the value to set
        Returns:
        the dsl builder

      • maxQueueSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        maxQueueSize - the value to set
        Returns:
        the dsl builder

      • maxQueueSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        maxQueueSize - the value to set
        Returns:
        the dsl builder

      • maxQueueSizeInBytes

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        maxQueueSizeInBytes - the value to set
        Returns:
        the dsl builder

      • maxQueueSizeInBytes

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        maxQueueSizeInBytes - the value to set
        Returns:
        the dsl builder

      • messageKeyColumns

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder messageKeyColumns​(String messageKeyColumns)
        A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':',where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector,and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key.Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        messageKeyColumns - the value to set
        Returns:
        the dsl builder

      • pollIntervalMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        pollIntervalMs - the value to set
        Returns:
        the dsl builder

      • pollIntervalMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        pollIntervalMs - the value to set
        Returns:
        the dsl builder

      • provideTransactionMetadata

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

      • provideTransactionMetadata

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        provideTransactionMetadata - the value to set
        Returns:
        the dsl builder

      • queryFetchSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        queryFetchSize - the value to set
        Returns:
        the dsl builder

      • queryFetchSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        queryFetchSize - the value to set
        Returns:
        the dsl builder

      • retriableRestartConnectorWaitMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        retriableRestartConnectorWaitMs - the value to set
        Returns:
        the dsl builder

      • retriableRestartConnectorWaitMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        retriableRestartConnectorWaitMs - the value to set
        Returns:
        the dsl builder

      • sanitizeFieldNames

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

      • sanitizeFieldNames

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        sanitizeFieldNames - the value to set
        Returns:
        the dsl builder

      • schemaNameAdjustmentMode

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        schemaNameAdjustmentMode - the value to set
        Returns:
        the dsl builder

      • signalDataCollection

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        signalDataCollection - the value to set
        Returns:
        the dsl builder

      • skippedOperations

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        skippedOperations - the value to set
        Returns:
        the dsl builder

      • snapshotDelayMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        snapshotDelayMs - the value to set
        Returns:
        the dsl builder

      • snapshotDelayMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        snapshotDelayMs - the value to set
        Returns:
        the dsl builder

      • snapshotFetchSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        snapshotFetchSize - the value to set
        Returns:
        the dsl builder

      • snapshotFetchSize

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        snapshotFetchSize - the value to set
        Returns:
        the dsl builder

      • snapshotIncludeCollectionList

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        snapshotIncludeCollectionList - the value to set
        Returns:
        the dsl builder

      • snapshotLockTimeoutMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder snapshotLockTimeoutMs​(long snapshotLockTimeoutMs)
        The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds. The option is a: <code>long</code> type. Default: 10s Group: db2
        Parameters:
        snapshotLockTimeoutMs - the value to set
        Returns:
        the dsl builder

      • snapshotLockTimeoutMs

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder snapshotLockTimeoutMs​(String snapshotLockTimeoutMs)
        The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds. The option will be converted to a <code>long</code> type. Default: 10s Group: db2
        Parameters:
        snapshotLockTimeoutMs - the value to set
        Returns:
        the dsl builder

      • snapshotMode

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder snapshotMode​(String snapshotMode)
        The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name. The option is a: <code>java.lang.String</code> type. Default: initial Group: db2
        Parameters:
        snapshotMode - the value to set
        Returns:
        the dsl builder

      • snapshotSelectStatementOverrides

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder snapshotSelectStatementOverrides​(String snapshotSelectStatementOverrides)
        This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        snapshotSelectStatementOverrides - the value to set
        Returns:
        the dsl builder

      • sourceStructVersion

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        sourceStructVersion - the value to set
        Returns:
        the dsl builder

      • tableBlacklist

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder tableBlacklist​(String tableBlacklist)
        A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead). The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        tableBlacklist - the value to set
        Returns:
        the dsl builder

      • tableExcludeList

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder tableExcludeList​(String tableExcludeList)
        A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring. The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        tableExcludeList - the value to set
        Returns:
        the dsl builder

      • tableIgnoreBuiltin

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder tableIgnoreBuiltin​(boolean tableIgnoreBuiltin)
        Flag specifying whether built-in tables should be ignored. The option is a: <code>boolean</code> type. Default: true Group: db2
        Parameters:
        tableIgnoreBuiltin - the value to set
        Returns:
        the dsl builder

      • tableIgnoreBuiltin

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder tableIgnoreBuiltin​(String tableIgnoreBuiltin)
        Flag specifying whether built-in tables should be ignored. The option will be converted to a <code>boolean</code> type. Default: true Group: db2
        Parameters:
        tableIgnoreBuiltin - the value to set
        Returns:
        the dsl builder

      • tableWhitelist

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder tableWhitelist​(String tableWhitelist)
        The tables for which changes are to be captured (deprecated, use table.include.list instead). The option is a: <code>java.lang.String</code> type. Group: db2
        Parameters:
        tableWhitelist - the value to set
        Returns:
        the dsl builder

      • timePrecisionMode

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder timePrecisionMode​(String timePrecisionMode)
        Time, date, and timestamps can be represented with different kinds of precisions, including:'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision;'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision . The option is a: <code>java.lang.String</code> type. Default: adaptive Group: db2
        Parameters:
        timePrecisionMode - the value to set
        Returns:
        the dsl builder

      • tombstonesOnDelete

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        tombstonesOnDelete - the value to set
        Returns:
        the dsl builder

      • tombstonesOnDelete

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        tombstonesOnDelete - the value to set
        Returns:
        the dsl builder

      • transactionTopic

        default DebeziumDb2EndpointBuilderFactory.DebeziumDb2EndpointBuilder 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: db2
        Parameters:
        transactionTopic - the value to set
        Returns:
        the dsl builder