Interface DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
-
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.debezium.DebeziumMongodbComponent>
- All Known Implementing Classes:
DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilderImpl
- Enclosing interface:
- DebeziumMongodbComponentBuilderFactory
public static interface DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder extends ComponentBuilder<org.apache.camel.component.debezium.DebeziumMongodbComponent>
Builder for the Debezium MongoDB Connector component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
additionalProperties(Map<String,Object> additionalProperties)
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..default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
captureMode(String captureMode)
The method used to capture changes from MongoDB server.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
collectionExcludeList(String collectionExcludeList)
A comma-separated list of regular expressions that match the collection names for which changes are to be excluded.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
collectionIncludeList(String collectionIncludeList)
A comma-separated list of regular expressions that match the collection names for which changes are to be captured.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
configuration(org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration configuration)
Allow pre-configured Configurations to be set.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
connectMaxAttempts(int connectMaxAttempts)
Maximum number of failed connection attempts to a replica set primary before an exception occurs and task is aborted.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
converters(String converters)
Optional list of custom converters that would be used instead of default ones.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
cursorMaxAwaitTimeMs(int cursorMaxAwaitTimeMs)
The maximum processing time in milliseconds to wait for the oplog cursor to process a single poll request.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
databaseExcludeList(String databaseExcludeList)
A comma-separated list of regular expressions that match the database names for which changes are to be excluded.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
databaseHistoryFileFilename(String databaseHistoryFileFilename)
The path to the file that will be used to record the database history.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
databaseIncludeList(String databaseIncludeList)
A comma-separated list of regular expressions that match the database names for which changes are to be captured.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
eventProcessingFailureHandlingMode(String eventProcessingFailureHandlingMode)
Specify how failures during processing of events (i.e.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
fieldExcludeList(String fieldExcludeList)
A comma-separated list of the fully-qualified names of fields that should be excluded from change event message values.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
heartbeatIntervalMs(int heartbeatIntervalMs)
Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
heartbeatTopicsPrefix(String heartbeatTopicsPrefix)
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
internalKeyConverter(String internalKeyConverter)
The Converter class that should be used to serialize and deserialize key data for offsets.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
internalValueConverter(String internalValueConverter)
The Converter class that should be used to serialize and deserialize value data for offsets.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
maxBatchSize(int maxBatchSize)
Maximum size of each batch of source records.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
maxQueueSize(int maxQueueSize)
Maximum size of the queue for change events read from the database log but not yet recorded or forwarded.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
maxQueueSizeInBytes(long maxQueueSizeInBytes)
Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbAuthsource(String mongodbAuthsource)
Database containing user credentials.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbConnectTimeoutMs(int mongodbConnectTimeoutMs)
The connection timeout, given in milliseconds.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbHosts(String mongodbHosts)
The hostname and port pairs (in the form 'host' or 'host:port') of the MongoDB server(s) in the replica set.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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').default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbPassword(String mongodbPassword)
Password to be used when connecting to MongoDB, if necessary.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbPollIntervalMs(long mongodbPollIntervalMs)
Interval for looking for new, removed, or changed replica sets, given in milliseconds.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbServerSelectionTimeoutMs(int mongodbServerSelectionTimeoutMs)
The server selection timeout, given in milliseconds.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbSocketTimeoutMs(int mongodbSocketTimeoutMs)
The socket timeout, given in milliseconds.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbSslEnabled(boolean mongodbSslEnabled)
Should connector use SSL to connect to MongoDB instances.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbSslInvalidHostnameAllowed(boolean mongodbSslInvalidHostnameAllowed)
Whether invalid host names are allowed when using SSL.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
mongodbUser(String mongodbUser)
Database user for connecting to MongoDB, if necessary.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
offsetCommitPolicy(String offsetCommitPolicy)
The name of the Java class of the commit policy.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
offsetFlushIntervalMs(long offsetFlushIntervalMs)
Interval at which to try committing offsets.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
offsetStorage(String offsetStorage)
The name of the Java class that is responsible for persistence of connector offsets.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
offsetStorageFileName(String offsetStorageFileName)
Path to file where offsets are to be stored.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
offsetStoragePartitions(int offsetStoragePartitions)
The number of partitions used when creating the offset storage topic.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
offsetStorageReplicationFactor(int offsetStorageReplicationFactor)
Replication factor used when creating the offset storage topic.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
offsetStorageTopic(String offsetStorageTopic)
The name of the Kafka topic where offsets are to be stored.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
pollIntervalMs(long pollIntervalMs)
Time to wait for new change events to appear after receiving no events, given in milliseconds.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
provideTransactionMetadata(boolean provideTransactionMetadata)
Enables transaction metadata extraction together with event counting.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
queryFetchSize(int queryFetchSize)
The maximum number of records that should be loaded into memory while streaming.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
retriableRestartConnectorWaitMs(long retriableRestartConnectorWaitMs)
Time to wait before restarting connector after retriable exception occurs.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
sanitizeFieldNames(boolean sanitizeFieldNames)
Whether field names will be sanitized to Avro naming conventions.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
signalDataCollection(String signalDataCollection)
The name of the data collection that is used to send signals/commands to Debezium.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
snapshotDelayMs(long snapshotDelayMs)
A delay period before a snapshot will begin, given in milliseconds.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
snapshotFetchSize(int snapshotFetchSize)
The maximum number of records that should be loaded into memory while performing a snapshot.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
snapshotMaxThreads(int snapshotMaxThreads)
The maximum number of threads used to perform the snapshot.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
snapshotMode(String snapshotMode)
The criteria for running a snapshot upon startup of the connector.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
sourceStructVersion(String sourceStructVersion)
A version of the format of the publicly visible source part in the message.default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
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).default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder
transactionTopic(String transactionTopic)
The name of the transaction metadata topic.-
Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
-
-
-
Method Detail
-
additionalProperties
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder additionalProperties(Map<String,Object> additionalProperties)
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: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. Group: common- Parameters:
additionalProperties
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
configuration
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder configuration(org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration configuration)
Allow pre-configured Configurations to be set. The option is a: <code>org.apache.camel.component.debezium.configuration.MongoDbConnectorEmbeddedDebeziumConfiguration</code> type. Group: consumer- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
internalKeyConverter
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
offsetFlushIntervalMs
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
offsetStorage
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
offsetStorageReplicationFactor
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
offsetStorageTopic
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
autowiredEnabled
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced- Parameters:
autowiredEnabled
- the value to set- Returns:
- the dsl builder
-
captureMode
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
connectBackoffMaxDelayMs
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
connectMaxAttempts
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
converters
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
databaseExcludeList
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
heartbeatTopicsPrefix
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder heartbeatTopicsPrefix(String heartbeatTopicsPrefix)
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. The option is a: <code>java.lang.String</code> type. Default: __debezium-heartbeat Group: mongodb- Parameters:
heartbeatTopicsPrefix
- the value to set- Returns:
- the dsl builder
-
maxBatchSize
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder maxBatchSize(int maxBatchSize)
Maximum size of each batch of source records. Defaults to 2048. The option is a: <code>int</code> type. Default: 2048 Group: mongodb- Parameters:
maxBatchSize
- the value to set- Returns:
- the dsl builder
-
maxQueueSize
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
maxQueueSizeInBytes
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
mongodbAuthsource
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder mongodbAuthsource(String mongodbAuthsource)
Database containing user credentials. The option is a: <code>java.lang.String</code> type. Default: admin Group: mongodb- Parameters:
mongodbAuthsource
- the value to set- Returns:
- the dsl builder
-
mongodbConnectTimeoutMs
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
mongodbHosts
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
mongodbName
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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. Group: mongodb- Parameters:
mongodbName
- the value to set- Returns:
- the dsl builder
-
mongodbPassword
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder mongodbPassword(String mongodbPassword)
Password to be used when connecting to MongoDB, if necessary. The option is a: <code>java.lang.String</code> type. Group: mongodb- Parameters:
mongodbPassword
- the value to set- Returns:
- the dsl builder
-
mongodbPollIntervalMs
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
mongodbServerSelectionTimeoutMs
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
mongodbSocketTimeoutMs
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
mongodbSslEnabled
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
mongodbUser
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder mongodbUser(String mongodbUser)
Database user for connecting to MongoDB, if necessary. The option is a: <code>java.lang.String</code> type. Group: mongodb- Parameters:
mongodbUser
- the value to set- Returns:
- the dsl builder
-
pollIntervalMs
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
provideTransactionMetadata
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
queryFetchSize
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
retriableRestartConnectorWaitMs
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
sanitizeFieldNames
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
schemaNameAdjustmentMode
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
snapshotFetchSize
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
snapshotIncludeCollectionList
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
snapshotMode
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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 DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
transactionTopic
default DebeziumMongodbComponentBuilderFactory.DebeziumMongodbComponentBuilder 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
-
-