// kafka-connector options: START
[[camel-vertx-kafka-kafka-connector-source]]
= camel-vertx-kafka-kafka-connector source configuration

When using camel-vertx-kafka-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-vertx-kafka-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>
----

To use this Source connector in Kafka connect you'll need to set the following connector.class

[source,java]
----
connector.class=org.apache.camel.kafkaconnector.vertxkafka.CamelVertxkafkaSourceConnector
----


The camel-vertx-kafka source connector supports 160 options, which are listed below.



[width="100%",cols="2,5,^1,1,1",options="header"]
|===
| Name | Description | Default | Required | Priority
| *camel.source.path.topic* | Name of the topic to use. On the consumer you can use comma to separate multiple topics. A producer can only send a message to a single topic. | null | true | HIGH
| *camel.source.endpoint.additionalProperties* | Sets additional properties for either kafka consumer or kafka producer in case they can't be set directly on the camel configurations (e.g: new Kafka properties that are not reflected yet in Camel configurations), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\http://localhost:8811/avro | null | false | MEDIUM
| *camel.source.endpoint.bootstrapServers* | A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping&mdash;this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form host1:port1,host2:port2,.... Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down). | null | false | MEDIUM
| *camel.source.endpoint.clientDnsLookup* | Controls how the client uses DNS lookups. If set to use_all_dns_ips, connect to each returned IP address in sequence until a successful connection is established. After a disconnection, the next IP is used. Once all IPs have been used once, the client resolves the IP(s) from the hostname again (both the JVM and the OS cache DNS name lookups, however). If set to resolve_canonical_bootstrap_servers_only, resolve each bootstrap address into a list of canonical names. After the bootstrap phase, this behaves the same as use_all_dns_ips. If set to default (deprecated), attempt to connect to the first IP address returned by the lookup, even if the lookup returns multiple IP addresses. One of: [default] [use_all_dns_ips] [resolve_canonical_bootstrap_servers_only] | "use_all_dns_ips" | false | MEDIUM
| *camel.source.endpoint.clientId* | An id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging. | null | false | MEDIUM
| *camel.source.endpoint.connectionsMaxIdleMs* | Close idle connections after the number of milliseconds specified by this config. | 540000L | false | MEDIUM
| *camel.source.endpoint.headerFilterStrategy* | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | null | false | MEDIUM
| *camel.source.endpoint.interceptorClasses* | A list of classes to use as interceptors. Implementing the org.apache.kafka.clients.producer.ProducerInterceptor interface allows you to intercept (and possibly mutate) the records received by the producer before they are published to the Kafka cluster. By default, there are no interceptors. | null | false | MEDIUM
| *camel.source.endpoint.metadataMaxAgeMs* | The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions. | 300000L | false | MEDIUM
| *camel.source.endpoint.metricReporters* | A list of classes to use as metrics reporters. Implementing the org.apache.kafka.common.metrics.MetricsReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics. | null | false | MEDIUM
| *camel.source.endpoint.metricsNumSamples* | The number of samples maintained to compute metrics. | 2 | false | MEDIUM
| *camel.source.endpoint.metricsRecordingLevel* | The highest recording level for metrics. One of: [INFO] [DEBUG] | "INFO" | false | MEDIUM
| *camel.source.endpoint.metricsSampleWindowMs* | The window of time a metrics sample is computed over. | 30000L | false | MEDIUM
| *camel.source.endpoint.partitionId* | The partition to which the record will be sent (or null if no partition was specified) or read from a particular partition if set. Header VertxKafkaConstants#PARTITION_ID If configured, it will take precedence over this config | null | false | MEDIUM
| *camel.source.endpoint.receiveBufferBytes* | The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. If the value is -1, the OS default will be used. | 32768 | false | MEDIUM
| *camel.source.endpoint.reconnectBackoffMaxMs* | The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms. | 1000L | false | MEDIUM
| *camel.source.endpoint.reconnectBackoffMs* | The base amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all connection attempts by the client to a broker. | 50L | false | MEDIUM
| *camel.source.endpoint.requestTimeoutMs* | The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted. This should be larger than replica.lag.time.max.ms (a broker configuration) to reduce the possibility of message duplication due to unnecessary producer retries. | 30000 | false | MEDIUM
| *camel.source.endpoint.retryBackoffMs* | The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios. | 100L | false | MEDIUM
| *camel.source.endpoint.sendBufferBytes* | The size of the TCP send buffer (SO_SNDBUF) to use when sending data. If the value is -1, the OS default will be used. | 131072 | false | MEDIUM
| *camel.source.endpoint.allowAutoCreateTopics* | Allow automatic topic creation on the broker when subscribing to or assigning a topic. A topic being subscribed to will be automatically created only if the broker allows for it using auto.create.topics.enable broker configuration. This configuration must be set to false when using brokers older than 0.11.0 | true | false | MEDIUM
| *camel.source.endpoint.autoCommitIntervalMs* | The frequency in milliseconds that the consumer offsets are auto-committed to Kafka if enable.auto.commit is set to true. | 5000 | false | MEDIUM
| *camel.source.endpoint.autoOffsetReset* | What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted): earliest: automatically reset the offset to the earliest offsetlatest: automatically reset the offset to the latest offsetnone: throw exception to the consumer if no previous offset is found for the consumer's groupanything else: throw exception to the consumer. One of: [latest] [earliest] [none] | "latest" | false | MEDIUM
| *camel.source.endpoint.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. | false | false | MEDIUM
| *camel.source.endpoint.checkCrcs* | Automatically check the CRC32 of the records consumed. This ensures no on-the-wire or on-disk corruption to the messages occurred. This check adds some overhead, so it may be disabled in cases seeking extreme performance. | true | false | MEDIUM
| *camel.source.endpoint.clientRack* | A rack identifier for this client. This can be any string value which indicates where this client is physically located. It corresponds with the broker config 'broker.rack' | null | false | MEDIUM
| *camel.source.endpoint.defaultApiTimeoutMs* | Specifies the timeout (in milliseconds) for client APIs. This configuration is used as the default timeout for all client operations that do not specify a timeout parameter. | 60000 | false | MEDIUM
| *camel.source.endpoint.enableAutoCommit* | If true the consumer's offset will be periodically committed in the background. | true | false | MEDIUM
| *camel.source.endpoint.excludeInternalTopics* | Whether internal topics matching a subscribed pattern should be excluded from the subscription. It is always possible to explicitly subscribe to an internal topic. | true | false | MEDIUM
| *camel.source.endpoint.fetchMaxBytes* | The maximum amount of data the server should return for a fetch request. Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Note that the consumer performs multiple fetches in parallel. | 52428800 | false | MEDIUM
| *camel.source.endpoint.fetchMaxWaitMs* | The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by fetch.min.bytes. | 500 | false | MEDIUM
| *camel.source.endpoint.fetchMinBytes* | The minimum amount of data the server should return for a fetch request. If insufficient data is available the request will wait for that much data to accumulate before answering the request. The default setting of 1 byte means that fetch requests are answered as soon as a single byte of data is available or the fetch request times out waiting for data to arrive. Setting this to something greater than 1 will cause the server to wait for larger amounts of data to accumulate which can improve server throughput a bit at the cost of some additional latency. | 1 | false | MEDIUM
| *camel.source.endpoint.groupId* | A unique string that identifies the consumer group this consumer belongs to. This property is required if the consumer uses either the group management functionality by using subscribe(topic) or the Kafka-based offset management strategy. | null | false | MEDIUM
| *camel.source.endpoint.groupInstanceId* | A unique identifier of the consumer instance provided by the end user. Only non-empty strings are permitted. If set, the consumer is treated as a static member, which means that only one instance with this ID is allowed in the consumer group at any time. This can be used in combination with a larger session timeout to avoid group rebalances caused by transient unavailability (e.g. process restarts). If not set, the consumer will join the group as a dynamic member, which is the traditional behavior. | null | false | MEDIUM
| *camel.source.endpoint.heartbeatIntervalMs* | The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than session.timeout.ms, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances. | 3000 | false | MEDIUM
| *camel.source.endpoint.isolationLevel* | Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted' (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. Messages will always be returned in offset order. Hence, in read_committed mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, read_committed consumers will not be able to read up to the high watermark when there are in flight transactions. Further, when in read_committed the seekToEnd method will return the LSO One of: [read_committed] [read_uncommitted] | "read_uncommitted" | false | MEDIUM
| *camel.source.endpoint.keyDeserializer* | Deserializer class for key that implements the org.apache.kafka.common.serialization.Deserializer interface. | "org.apache.kafka.common.serialization.StringDeserializer" | false | MEDIUM
| *camel.source.endpoint.maxPartitionFetchBytes* | The maximum amount of data per-partition the server will return. Records are fetched in batches by the consumer. If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). See fetch.max.bytes for limiting the consumer request size. | 1048576 | false | MEDIUM
| *camel.source.endpoint.maxPollIntervalMs* | The maximum delay between invocations of poll() when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records. If poll() is not called before expiration of this timeout, then the consumer is considered failed and the group will rebalance in order to reassign the partitions to another member. For consumers using a non-null group.instance.id which reach this timeout, partitions will not be immediately reassigned. Instead, the consumer will stop sending heartbeats and partitions will be reassigned after expiration of session.timeout.ms. This mirrors the behavior of a static consumer which has shutdown. | 300000 | false | MEDIUM
| *camel.source.endpoint.maxPollRecords* | The maximum number of records returned in a single call to poll(). | 500 | false | MEDIUM
| *camel.source.endpoint.partitionAssignmentStrategy* | A list of class names or class types, ordered by preference, of supported partition assignment strategies that the client will use to distribute partition ownership amongst consumer instances when group management is used.In addition to the default class specified below, you can use the org.apache.kafka.clients.consumer.RoundRobinAssignorclass for round robin assignments of partitions to consumers. Implementing the org.apache.kafka.clients.consumer.ConsumerPartitionAssignor interface allows you to plug in a custom assignmentstrategy. | "org.apache.kafka.clients.consumer.RangeAssignor" | false | MEDIUM
| *camel.source.endpoint.seekToOffset* | Set if KafkaConsumer will read from a particular offset on startup. This config will take precedence over seekTo config | null | false | MEDIUM
| *camel.source.endpoint.seekToPosition* | Set if KafkaConsumer will read from beginning or end on startup: beginning : read from beginning end : read from end. One of: [beginning] [end] | null | false | MEDIUM
| *camel.source.endpoint.sessionTimeoutMs* | The timeout used to detect client failures when using Kafka's group management facility. The client sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this client from the group and initiate a rebalance. Note that the value must be in the allowable range as configured in the broker configuration by group.min.session.timeout.ms and group.max.session.timeout.ms. | 10000 | false | MEDIUM
| *camel.source.endpoint.valueDeserializer* | Deserializer class for value that implements the org.apache.kafka.common.serialization.Deserializer interface. | "org.apache.kafka.common.serialization.StringDeserializer" | false | MEDIUM
| *camel.source.endpoint.exceptionHandler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | false | MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | false | MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | false | MEDIUM
| *camel.source.endpoint.saslClientCallbackHandler Class* | The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface. | null | false | MEDIUM
| *camel.source.endpoint.saslJaasConfig* | JAAS login context parameters for SASL connections in the format used by JAAS configuration files. JAAS configuration file format is described here. The format for the value is: 'loginModuleClass controlFlag (optionName=optionValue);'. For brokers, the config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.jaas.config=com.example.ScramLoginModule required; | null | false | MEDIUM
| *camel.source.endpoint.saslKerberosKinitCmd* | Kerberos kinit command path. | "/usr/bin/kinit" | false | MEDIUM
| *camel.source.endpoint.saslKerberosMinTimeBefore Relogin* | Login thread sleep time between refresh attempts. | 60000L | false | MEDIUM
| *camel.source.endpoint.saslKerberosServiceName* | The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. | null | false | MEDIUM
| *camel.source.endpoint.saslKerberosTicketRenew Jitter* | Percentage of random jitter added to the renewal time. | 0.05D | false | MEDIUM
| *camel.source.endpoint.saslKerberosTicketRenew WindowFactor* | Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket. | 0.8D | false | MEDIUM
| *camel.source.endpoint.saslLoginCallbackHandler Class* | The fully qualified name of a SASL login callback handler class that implements the AuthenticateCallbackHandler interface. For brokers, login callback handler config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.callback.handler.class=com.example.CustomScramLoginCallbackHandler | null | false | MEDIUM
| *camel.source.endpoint.saslLoginClass* | The fully qualified name of a class that implements the Login interface. For brokers, login config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.class=com.example.CustomScramLogin | null | false | MEDIUM
| *camel.source.endpoint.saslLoginRefreshBuffer Seconds* | The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds. If a refresh would otherwise occur closer to expiration than the number of buffer seconds then the refresh will be moved up to maintain as much of the buffer time as possible. Legal values are between 0 and 3600 (1 hour); a default value of 300 (5 minutes) is used if no value is specified. This value and sasl.login.refresh.min.period.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER. | 300 | false | MEDIUM
| *camel.source.endpoint.saslLoginRefreshMinPeriod Seconds* | The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds. Legal values are between 0 and 900 (15 minutes); a default value of 60 (1 minute) is used if no value is specified. This value and sasl.login.refresh.buffer.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER. | 60 | false | MEDIUM
| *camel.source.endpoint.saslLoginRefreshWindowFactor* | Login refresh thread will sleep until the specified window factor relative to the credential's lifetime has been reached, at which time it will try to refresh the credential. Legal values are between 0.5 (50%) and 1.0 (100%) inclusive; a default value of 0.8 (80%) is used if no value is specified. Currently applies only to OAUTHBEARER. | 0.8D | false | MEDIUM
| *camel.source.endpoint.saslLoginRefreshWindowJitter* | The maximum amount of random jitter relative to the credential's lifetime that is added to the login refresh thread's sleep time. Legal values are between 0 and 0.25 (25%) inclusive; a default value of 0.05 (5%) is used if no value is specified. Currently applies only to OAUTHBEARER. | 0.05D | false | MEDIUM
| *camel.source.endpoint.saslMechanism* | SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism. | "GSSAPI" | false | MEDIUM
| *camel.source.endpoint.securityProtocol* | Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. | "PLAINTEXT" | false | MEDIUM
| *camel.source.endpoint.securityProviders* | A list of configurable creator classes each returning a provider implementing security algorithms. These classes should implement the org.apache.kafka.common.security.auth.SecurityProviderCreator interface. | null | false | MEDIUM
| *camel.source.endpoint.sslCipherSuites* | A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default all the available cipher suites are supported. | null | false | MEDIUM
| *camel.source.endpoint.sslEnabledProtocols* | The list of protocols enabled for SSL connections. The default is 'TLSv1.2,TLSv1.3' when running with Java 11 or newer, 'TLSv1.2' otherwise. With the default value for Java 11, clients and servers will prefer TLSv1.3 if both support it and fallback to TLSv1.2 otherwise (assuming both support at least TLSv1.2). This default should be fine for most cases. Also see the config documentation for ssl.protocol. | "TLSv1.2,TLSv1.3" | false | MEDIUM
| *camel.source.endpoint.sslEndpointIdentification Algorithm* | The endpoint identification algorithm to validate server hostname using server certificate. | "https" | false | MEDIUM
| *camel.source.endpoint.sslEngineFactoryClass* | The class of type org.apache.kafka.common.security.auth.SslEngineFactory to provide SSLEngine objects. Default value is org.apache.kafka.common.security.ssl.DefaultSslEngineFactory | null | false | MEDIUM
| *camel.source.endpoint.sslKeymanagerAlgorithm* | The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine. | "SunX509" | false | MEDIUM
| *camel.source.endpoint.sslKeyPassword* | The password of the private key in the key store file. This is optional for client. | null | false | MEDIUM
| *camel.source.endpoint.sslKeystoreLocation* | The location of the key store file. This is optional for client and can be used for two-way authentication for client. | null | false | MEDIUM
| *camel.source.endpoint.sslKeystorePassword* | The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured. | null | false | MEDIUM
| *camel.source.endpoint.sslKeystoreType* | The file format of the key store file. This is optional for client. | "JKS" | false | MEDIUM
| *camel.source.endpoint.sslProtocol* | The SSL protocol used to generate the SSLContext. The default is 'TLSv1.3' when running with Java 11 or newer, 'TLSv1.2' otherwise. This value should be fine for most use cases. Allowed values in recent JVMs are 'TLSv1.2' and 'TLSv1.3'. 'TLS', 'TLSv1.1', 'SSL', 'SSLv2' and 'SSLv3' may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. With the default value for this config and 'ssl.enabled.protocols', clients will downgrade to 'TLSv1.2' if the server does not support 'TLSv1.3'. If this config is set to 'TLSv1.2', clients will not use 'TLSv1.3' even if it is one of the values in ssl.enabled.protocols and the server only supports 'TLSv1.3'. | "TLSv1.2" | false | MEDIUM
| *camel.source.endpoint.sslProvider* | The name of the security provider used for SSL connections. Default value is the default security provider of the JVM. | null | false | MEDIUM
| *camel.source.endpoint.sslSecureRandom Implementation* | The SecureRandom PRNG implementation to use for SSL cryptography operations. | null | false | MEDIUM
| *camel.source.endpoint.sslTrustmanagerAlgorithm* | The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine. | "PKIX" | false | MEDIUM
| *camel.source.endpoint.sslTruststoreLocation* | The location of the trust store file. | null | false | MEDIUM
| *camel.source.endpoint.sslTruststorePassword* | The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled. | null | false | MEDIUM
| *camel.source.endpoint.sslTruststoreType* | The file format of the trust store file. | "JKS" | false | MEDIUM
| *camel.component.vertx-kafka.additionalProperties* | Sets additional properties for either kafka consumer or kafka producer in case they can't be set directly on the camel configurations (e.g: new Kafka properties that are not reflected yet in Camel configurations), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\http://localhost:8811/avro | null | false | MEDIUM
| *camel.component.vertx-kafka.bootstrapServers* | A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping&mdash;this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form host1:port1,host2:port2,.... Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down). | null | false | MEDIUM
| *camel.component.vertx-kafka.clientDnsLookup* | Controls how the client uses DNS lookups. If set to use_all_dns_ips, connect to each returned IP address in sequence until a successful connection is established. After a disconnection, the next IP is used. Once all IPs have been used once, the client resolves the IP(s) from the hostname again (both the JVM and the OS cache DNS name lookups, however). If set to resolve_canonical_bootstrap_servers_only, resolve each bootstrap address into a list of canonical names. After the bootstrap phase, this behaves the same as use_all_dns_ips. If set to default (deprecated), attempt to connect to the first IP address returned by the lookup, even if the lookup returns multiple IP addresses. One of: [default] [use_all_dns_ips] [resolve_canonical_bootstrap_servers_only] | "use_all_dns_ips" | false | MEDIUM
| *camel.component.vertx-kafka.clientId* | An id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging. | null | false | MEDIUM
| *camel.component.vertx-kafka.configuration* | The component configurations | null | false | MEDIUM
| *camel.component.vertx-kafka.connectionsMaxIdleMs* | Close idle connections after the number of milliseconds specified by this config. | 540000L | false | MEDIUM
| *camel.component.vertx-kafka.headerFilterStrategy* | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | null | false | MEDIUM
| *camel.component.vertx-kafka.interceptorClasses* | A list of classes to use as interceptors. Implementing the org.apache.kafka.clients.producer.ProducerInterceptor interface allows you to intercept (and possibly mutate) the records received by the producer before they are published to the Kafka cluster. By default, there are no interceptors. | null | false | MEDIUM
| *camel.component.vertx-kafka.metadataMaxAgeMs* | The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions. | 300000L | false | MEDIUM
| *camel.component.vertx-kafka.metricReporters* | A list of classes to use as metrics reporters. Implementing the org.apache.kafka.common.metrics.MetricsReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics. | null | false | MEDIUM
| *camel.component.vertx-kafka.metricsNumSamples* | The number of samples maintained to compute metrics. | 2 | false | MEDIUM
| *camel.component.vertx-kafka.metricsRecordingLevel* | The highest recording level for metrics. One of: [INFO] [DEBUG] | "INFO" | false | MEDIUM
| *camel.component.vertx-kafka.metricsSampleWindowMs* | The window of time a metrics sample is computed over. | 30000L | false | MEDIUM
| *camel.component.vertx-kafka.partitionId* | The partition to which the record will be sent (or null if no partition was specified) or read from a particular partition if set. Header VertxKafkaConstants#PARTITION_ID If configured, it will take precedence over this config | null | false | MEDIUM
| *camel.component.vertx-kafka.receiveBufferBytes* | The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. If the value is -1, the OS default will be used. | 32768 | false | MEDIUM
| *camel.component.vertx-kafka.reconnectBackoffMaxMs* | The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms. | 1000L | false | MEDIUM
| *camel.component.vertx-kafka.reconnectBackoffMs* | The base amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all connection attempts by the client to a broker. | 50L | false | MEDIUM
| *camel.component.vertx-kafka.requestTimeoutMs* | The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted. This should be larger than replica.lag.time.max.ms (a broker configuration) to reduce the possibility of message duplication due to unnecessary producer retries. | 30000 | false | MEDIUM
| *camel.component.vertx-kafka.retryBackoffMs* | The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios. | 100L | false | MEDIUM
| *camel.component.vertx-kafka.sendBufferBytes* | The size of the TCP send buffer (SO_SNDBUF) to use when sending data. If the value is -1, the OS default will be used. | 131072 | false | MEDIUM
| *camel.component.vertx-kafka.allowAutoCreateTopics* | Allow automatic topic creation on the broker when subscribing to or assigning a topic. A topic being subscribed to will be automatically created only if the broker allows for it using auto.create.topics.enable broker configuration. This configuration must be set to false when using brokers older than 0.11.0 | true | false | MEDIUM
| *camel.component.vertx-kafka.autoCommitIntervalMs* | The frequency in milliseconds that the consumer offsets are auto-committed to Kafka if enable.auto.commit is set to true. | 5000 | false | MEDIUM
| *camel.component.vertx-kafka.autoOffsetReset* | What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted): earliest: automatically reset the offset to the earliest offsetlatest: automatically reset the offset to the latest offsetnone: throw exception to the consumer if no previous offset is found for the consumer's groupanything else: throw exception to the consumer. One of: [latest] [earliest] [none] | "latest" | false | MEDIUM
| *camel.component.vertx-kafka.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. | false | false | MEDIUM
| *camel.component.vertx-kafka.checkCrcs* | Automatically check the CRC32 of the records consumed. This ensures no on-the-wire or on-disk corruption to the messages occurred. This check adds some overhead, so it may be disabled in cases seeking extreme performance. | true | false | MEDIUM
| *camel.component.vertx-kafka.clientRack* | A rack identifier for this client. This can be any string value which indicates where this client is physically located. It corresponds with the broker config 'broker.rack' | null | false | MEDIUM
| *camel.component.vertx-kafka.defaultApiTimeoutMs* | Specifies the timeout (in milliseconds) for client APIs. This configuration is used as the default timeout for all client operations that do not specify a timeout parameter. | 60000 | false | MEDIUM
| *camel.component.vertx-kafka.enableAutoCommit* | If true the consumer's offset will be periodically committed in the background. | true | false | MEDIUM
| *camel.component.vertx-kafka.excludeInternalTopics* | Whether internal topics matching a subscribed pattern should be excluded from the subscription. It is always possible to explicitly subscribe to an internal topic. | true | false | MEDIUM
| *camel.component.vertx-kafka.fetchMaxBytes* | The maximum amount of data the server should return for a fetch request. Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Note that the consumer performs multiple fetches in parallel. | 52428800 | false | MEDIUM
| *camel.component.vertx-kafka.fetchMaxWaitMs* | The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy the requirement given by fetch.min.bytes. | 500 | false | MEDIUM
| *camel.component.vertx-kafka.fetchMinBytes* | The minimum amount of data the server should return for a fetch request. If insufficient data is available the request will wait for that much data to accumulate before answering the request. The default setting of 1 byte means that fetch requests are answered as soon as a single byte of data is available or the fetch request times out waiting for data to arrive. Setting this to something greater than 1 will cause the server to wait for larger amounts of data to accumulate which can improve server throughput a bit at the cost of some additional latency. | 1 | false | MEDIUM
| *camel.component.vertx-kafka.groupId* | A unique string that identifies the consumer group this consumer belongs to. This property is required if the consumer uses either the group management functionality by using subscribe(topic) or the Kafka-based offset management strategy. | null | false | MEDIUM
| *camel.component.vertx-kafka.groupInstanceId* | A unique identifier of the consumer instance provided by the end user. Only non-empty strings are permitted. If set, the consumer is treated as a static member, which means that only one instance with this ID is allowed in the consumer group at any time. This can be used in combination with a larger session timeout to avoid group rebalances caused by transient unavailability (e.g. process restarts). If not set, the consumer will join the group as a dynamic member, which is the traditional behavior. | null | false | MEDIUM
| *camel.component.vertx-kafka.heartbeatIntervalMs* | The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than session.timeout.ms, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances. | 3000 | false | MEDIUM
| *camel.component.vertx-kafka.isolationLevel* | Controls how to read messages written transactionally. If set to read_committed, consumer.poll() will only return transactional messages which have been committed. If set to read_uncommitted' (the default), consumer.poll() will return all messages, even transactional messages which have been aborted. Non-transactional messages will be returned unconditionally in either mode. Messages will always be returned in offset order. Hence, in read_committed mode, consumer.poll() will only return messages up to the last stable offset (LSO), which is the one less than the offset of the first open transaction. In particular any messages appearing after messages belonging to ongoing transactions will be withheld until the relevant transaction has been completed. As a result, read_committed consumers will not be able to read up to the high watermark when there are in flight transactions. Further, when in read_committed the seekToEnd method will return the LSO One of: [read_committed] [read_uncommitted] | "read_uncommitted" | false | MEDIUM
| *camel.component.vertx-kafka.keyDeserializer* | Deserializer class for key that implements the org.apache.kafka.common.serialization.Deserializer interface. | "org.apache.kafka.common.serialization.StringDeserializer" | false | MEDIUM
| *camel.component.vertx-kafka.maxPartitionFetchBytes* | The maximum amount of data per-partition the server will return. Records are fetched in batches by the consumer. If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. The maximum record batch size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). See fetch.max.bytes for limiting the consumer request size. | 1048576 | false | MEDIUM
| *camel.component.vertx-kafka.maxPollIntervalMs* | The maximum delay between invocations of poll() when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records. If poll() is not called before expiration of this timeout, then the consumer is considered failed and the group will rebalance in order to reassign the partitions to another member. For consumers using a non-null group.instance.id which reach this timeout, partitions will not be immediately reassigned. Instead, the consumer will stop sending heartbeats and partitions will be reassigned after expiration of session.timeout.ms. This mirrors the behavior of a static consumer which has shutdown. | 300000 | false | MEDIUM
| *camel.component.vertx-kafka.maxPollRecords* | The maximum number of records returned in a single call to poll(). | 500 | false | MEDIUM
| *camel.component.vertx-kafka.partitionAssignment Strategy* | A list of class names or class types, ordered by preference, of supported partition assignment strategies that the client will use to distribute partition ownership amongst consumer instances when group management is used.In addition to the default class specified below, you can use the org.apache.kafka.clients.consumer.RoundRobinAssignorclass for round robin assignments of partitions to consumers. Implementing the org.apache.kafka.clients.consumer.ConsumerPartitionAssignor interface allows you to plug in a custom assignmentstrategy. | "org.apache.kafka.clients.consumer.RangeAssignor" | false | MEDIUM
| *camel.component.vertx-kafka.seekToOffset* | Set if KafkaConsumer will read from a particular offset on startup. This config will take precedence over seekTo config | null | false | MEDIUM
| *camel.component.vertx-kafka.seekToPosition* | Set if KafkaConsumer will read from beginning or end on startup: beginning : read from beginning end : read from end. One of: [beginning] [end] | null | false | MEDIUM
| *camel.component.vertx-kafka.sessionTimeoutMs* | The timeout used to detect client failures when using Kafka's group management facility. The client sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this client from the group and initiate a rebalance. Note that the value must be in the allowable range as configured in the broker configuration by group.min.session.timeout.ms and group.max.session.timeout.ms. | 10000 | false | MEDIUM
| *camel.component.vertx-kafka.valueDeserializer* | Deserializer class for value that implements the org.apache.kafka.common.serialization.Deserializer interface. | "org.apache.kafka.common.serialization.StringDeserializer" | false | MEDIUM
| *camel.component.vertx-kafka.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. | true | false | MEDIUM
| *camel.component.vertx-kafka.vertx* | To use an existing vertx instead of creating a new instance | null | false | MEDIUM
| *camel.component.vertx-kafka.vertxOptions* | To provide a custom set of vertx options for configuring vertx | null | false | MEDIUM
| *camel.component.vertx-kafka.saslClientCallback HandlerClass* | The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface. | null | false | MEDIUM
| *camel.component.vertx-kafka.saslJaasConfig* | JAAS login context parameters for SASL connections in the format used by JAAS configuration files. JAAS configuration file format is described here. The format for the value is: 'loginModuleClass controlFlag (optionName=optionValue);'. For brokers, the config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.jaas.config=com.example.ScramLoginModule required; | null | false | MEDIUM
| *camel.component.vertx-kafka.saslKerberosKinitCmd* | Kerberos kinit command path. | "/usr/bin/kinit" | false | MEDIUM
| *camel.component.vertx-kafka.saslKerberosMinTime BeforeRelogin* | Login thread sleep time between refresh attempts. | 60000L | false | MEDIUM
| *camel.component.vertx-kafka.saslKerberosService Name* | The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. | null | false | MEDIUM
| *camel.component.vertx-kafka.saslKerberosTicket RenewJitter* | Percentage of random jitter added to the renewal time. | 0.05D | false | MEDIUM
| *camel.component.vertx-kafka.saslKerberosTicket RenewWindowFactor* | Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket. | 0.8D | false | MEDIUM
| *camel.component.vertx-kafka.saslLoginCallback HandlerClass* | The fully qualified name of a SASL login callback handler class that implements the AuthenticateCallbackHandler interface. For brokers, login callback handler config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.callback.handler.class=com.example.CustomScramLoginCallbackHandler | null | false | MEDIUM
| *camel.component.vertx-kafka.saslLoginClass* | The fully qualified name of a class that implements the Login interface. For brokers, login config must be prefixed with listener prefix and SASL mechanism name in lower-case. For example, listener.name.sasl_ssl.scram-sha-256.sasl.login.class=com.example.CustomScramLogin | null | false | MEDIUM
| *camel.component.vertx-kafka.saslLoginRefreshBuffer Seconds* | The amount of buffer time before credential expiration to maintain when refreshing a credential, in seconds. If a refresh would otherwise occur closer to expiration than the number of buffer seconds then the refresh will be moved up to maintain as much of the buffer time as possible. Legal values are between 0 and 3600 (1 hour); a default value of 300 (5 minutes) is used if no value is specified. This value and sasl.login.refresh.min.period.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER. | 300 | false | MEDIUM
| *camel.component.vertx-kafka.saslLoginRefreshMin PeriodSeconds* | The desired minimum time for the login refresh thread to wait before refreshing a credential, in seconds. Legal values are between 0 and 900 (15 minutes); a default value of 60 (1 minute) is used if no value is specified. This value and sasl.login.refresh.buffer.seconds are both ignored if their sum exceeds the remaining lifetime of a credential. Currently applies only to OAUTHBEARER. | 60 | false | MEDIUM
| *camel.component.vertx-kafka.saslLoginRefreshWindow Factor* | Login refresh thread will sleep until the specified window factor relative to the credential's lifetime has been reached, at which time it will try to refresh the credential. Legal values are between 0.5 (50%) and 1.0 (100%) inclusive; a default value of 0.8 (80%) is used if no value is specified. Currently applies only to OAUTHBEARER. | 0.8D | false | MEDIUM
| *camel.component.vertx-kafka.saslLoginRefreshWindow Jitter* | The maximum amount of random jitter relative to the credential's lifetime that is added to the login refresh thread's sleep time. Legal values are between 0 and 0.25 (25%) inclusive; a default value of 0.05 (5%) is used if no value is specified. Currently applies only to OAUTHBEARER. | 0.05D | false | MEDIUM
| *camel.component.vertx-kafka.saslMechanism* | SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism. | "GSSAPI" | false | MEDIUM
| *camel.component.vertx-kafka.securityProtocol* | Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. | "PLAINTEXT" | false | MEDIUM
| *camel.component.vertx-kafka.securityProviders* | A list of configurable creator classes each returning a provider implementing security algorithms. These classes should implement the org.apache.kafka.common.security.auth.SecurityProviderCreator interface. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslCipherSuites* | A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol. By default all the available cipher suites are supported. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslEnabledProtocols* | The list of protocols enabled for SSL connections. The default is 'TLSv1.2,TLSv1.3' when running with Java 11 or newer, 'TLSv1.2' otherwise. With the default value for Java 11, clients and servers will prefer TLSv1.3 if both support it and fallback to TLSv1.2 otherwise (assuming both support at least TLSv1.2). This default should be fine for most cases. Also see the config documentation for ssl.protocol. | "TLSv1.2,TLSv1.3" | false | MEDIUM
| *camel.component.vertx-kafka.sslEndpoint IdentificationAlgorithm* | The endpoint identification algorithm to validate server hostname using server certificate. | "https" | false | MEDIUM
| *camel.component.vertx-kafka.sslEngineFactoryClass* | The class of type org.apache.kafka.common.security.auth.SslEngineFactory to provide SSLEngine objects. Default value is org.apache.kafka.common.security.ssl.DefaultSslEngineFactory | null | false | MEDIUM
| *camel.component.vertx-kafka.sslKeymanagerAlgorithm* | The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine. | "SunX509" | false | MEDIUM
| *camel.component.vertx-kafka.sslKeyPassword* | The password of the private key in the key store file. This is optional for client. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslKeystoreLocation* | The location of the key store file. This is optional for client and can be used for two-way authentication for client. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslKeystorePassword* | The store password for the key store file. This is optional for client and only needed if ssl.keystore.location is configured. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslKeystoreType* | The file format of the key store file. This is optional for client. | "JKS" | false | MEDIUM
| *camel.component.vertx-kafka.sslProtocol* | The SSL protocol used to generate the SSLContext. The default is 'TLSv1.3' when running with Java 11 or newer, 'TLSv1.2' otherwise. This value should be fine for most use cases. Allowed values in recent JVMs are 'TLSv1.2' and 'TLSv1.3'. 'TLS', 'TLSv1.1', 'SSL', 'SSLv2' and 'SSLv3' may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities. With the default value for this config and 'ssl.enabled.protocols', clients will downgrade to 'TLSv1.2' if the server does not support 'TLSv1.3'. If this config is set to 'TLSv1.2', clients will not use 'TLSv1.3' even if it is one of the values in ssl.enabled.protocols and the server only supports 'TLSv1.3'. | "TLSv1.2" | false | MEDIUM
| *camel.component.vertx-kafka.sslProvider* | The name of the security provider used for SSL connections. Default value is the default security provider of the JVM. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslSecureRandom Implementation* | The SecureRandom PRNG implementation to use for SSL cryptography operations. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslTrustmanager Algorithm* | The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine. | "PKIX" | false | MEDIUM
| *camel.component.vertx-kafka.sslTruststoreLocation* | The location of the trust store file. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslTruststorePassword* | The password for the trust store file. If a password is not set access to the truststore is still available, but integrity checking is disabled. | null | false | MEDIUM
| *camel.component.vertx-kafka.sslTruststoreType* | The file format of the trust store file. | "JKS" | false | MEDIUM
|===



The camel-vertx-kafka source connector has no converters out of the box.





The camel-vertx-kafka source connector has no transforms out of the box.





The camel-vertx-kafka source connector has no aggregation strategies out of the box.
// kafka-connector options: END
