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&additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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

      • 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&additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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

      • bridgeErrorHandler

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer

      • bridgeErrorHandler

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a boolean type. Default: false Group: consumer

      • 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: java.lang.String type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer

      • 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: java.lang.String type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer

      • 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: java.lang.String type. Default: io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy Group: consumer

      • 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: long type. Default: 5s Group: consumer

      • 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 long type. Default: 5s Group: consumer

      • 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: int type. Group: consumer

      • 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: int type. Group: consumer

      • 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 int type. Group: consumer

      • 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. Defaults to 1 second (1000 ms). The option is a: long type. Default: 1s Group: mongodb

      • 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. Defaults to 1 second (1000 ms). The option will be converted to a long type. Default: 1s Group: mongodb

      • 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. Defaults to 120 second (120,000 ms). The option is a: long type. Default: 2m Group: mongodb

      • 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. Defaults to 120 second (120,000 ms). The option will be converted to a long type. Default: 2m Group: mongodb

      • 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: int type. Default: 16 Group: mongodb

      • 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 int type. Default: 16 Group: mongodb

      • 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: int type. Default: 0ms Group: mongodb

      • 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 int type. Default: 0ms Group: mongodb

      • 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: int type. Default: 8192 Group: mongodb

      • 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 int type. Default: 8192 Group: mongodb

      • 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: boolean type. Default: true Group: mongodb

      • 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 boolean type. Default: true Group: mongodb

      • mongodbName

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder mongodbName​(String mongodbName)
        Unique name that identifies the MongoDB replica set or cluster and all recorded offsets, andthat 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: java.lang.String type. Required: true Group: mongodb

      • 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: boolean type. Default: false Group: mongodb

      • 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 boolean type. Default: false Group: mongodb

      • skippedOperations

        default DebeziumMongodbEndpointBuilderFactory.DebeziumMongodbEndpointBuilder skippedOperations​(String skippedOperations)
        The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped. The option is a: java.lang.String type. Group: mongodb

      • 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: java.lang.String type. Default: initial Group: mongodb

      • 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: boolean type. Default: false Group: mongodb

      • 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 boolean type. Default: false Group: mongodb