2 Home
gitea_admin edited this page 2026-10-12 05:32:35 +00:00

Kafka Batch Source

Receive data from Kafka topics in batch and commit them manually through KafkaManualCommit. This provides complete control over when messages are committed, allowing for custom processing logic before acknowledgment.

Metadata

Property Value
Type source
Group Kafka
Namespace Kafka
Support Level Stable
Provider Apache Software Foundation

Properties

Name Type Required Default Description
topic string ✓ Comma separated list of Kafka topic names
bootstrapServers string ✓ Comma separated list of Kafka Broker URLs
saslAuthType string NONE Authentication type to use. Use NONE for no authentication, PLAIN or SCRAM_SHA_256/SCRAM_SHA_512 for username/password, SSL for certificate-based, OAUTH for OAuth 2.0, AWS_MSK_IAM for MSK, or KERBEROS for Kerberos.
saslUsername string Username for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.
saslPassword string Password for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512.
oauthClientId string OAuth client ID. Required when saslAuthType is OAUTH.
oauthClientSecret string OAuth client secret. Required when saslAuthType is OAUTH.
oauthTokenEndpointUri string OAuth token endpoint URI. Required when saslAuthType is OAUTH.
oauthScope string OAuth scope. Optional when saslAuthType is OAUTH.
sslTruststoreLocation string The location of the trust store file.
sslTruststorePassword string The password for the trust store file.
sslKeystoreLocation string The location of the key store file. Used for mTLS authentication.
sslKeystorePassword string The password for the key store file.
sslKeyPassword string The password of the private key in the key store file.
autoCommitEnable boolean true If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer
allowManualCommit boolean false Whether to allow doing manual commits
pollOnError string ERROR_HANDLER What to do if kafka threw an exception while polling for new messages. There are 5 enums and the value can be one of DISCARD, ERROR_HANDLER, RECONNECT, RETRY, STOP
autoOffsetReset string latest What to do when there is no initial offset. There are 3 enums and the value can be one of latest, earliest, none
consumerGroup string A string that uniquely identifies the group of consumers to which this source belongs
deserializeHeaders boolean true When enabled the Kamelet source will deserialize all message headers to String representation.
batchSize integer 500 The maximum number of records returned in a single call to poll()
pollTimeout integer 5000 The timeout used when polling the KafkaConsumer
maxPollIntervalMs integer The maximum delay between invocations of poll() when using consumer group management
batchingIntervalMs integer In consumer batching mode, then this option is specifying a time in millis, to trigger batch completion eager when the current batch size has not reached the maximum size defined by maxPollRecords. Notice the trigger is not exact at the given interval, as this can only happen between kafka polls (see pollTimeoutMs option).
topicIsPattern boolean false Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern.

Dependencies

  • camel:core
  • camel:kafka
  • camel:kamelet