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

Interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointBuilder
    Enclosing interface:
    VertxKafkaEndpointBuilderFactory
    public static interface VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Vert.x Kafka component.

    • Method Detail

      • additionalProperties

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder additionalProperties​(String key,
                                                                                                Object value)
        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&amp;additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • additionalProperties

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder additionalProperties​(Map values)
        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&amp;additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • bootstrapServers

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder bootstrapServers​(String 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&amp;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). The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        bootstrapServers - the value to set
        Returns:
        the dsl builder

      • clientDnsLookup

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder clientDnsLookup​(String 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. The option is a: <code>java.lang.String</code> type. Default: use_all_dns_ips Group: common
        Parameters:
        clientDnsLookup - the value to set
        Returns:
        the dsl builder

      • clientId

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder clientId​(String 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. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        clientId - the value to set
        Returns:
        the dsl builder

      • connectionsMaxIdleMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder connectionsMaxIdleMs​(long connectionsMaxIdleMs)
        Close idle connections after the number of milliseconds specified by this config. The option is a: <code>long</code> type. Default: 9m Group: common
        Parameters:
        connectionsMaxIdleMs - the value to set
        Returns:
        the dsl builder

      • connectionsMaxIdleMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder connectionsMaxIdleMs​(String connectionsMaxIdleMs)
        Close idle connections after the number of milliseconds specified by this config. The option will be converted to a <code>long</code> type. Default: 9m Group: common
        Parameters:
        connectionsMaxIdleMs - the value to set
        Returns:
        the dsl builder

      • headerFilterStrategy

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder headerFilterStrategy​(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
        To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common
        Parameters:
        headerFilterStrategy - the value to set
        Returns:
        the dsl builder

      • headerFilterStrategy

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder headerFilterStrategy​(String headerFilterStrategy)
        To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common
        Parameters:
        headerFilterStrategy - the value to set
        Returns:
        the dsl builder

      • interceptorClasses

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder interceptorClasses​(String 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. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        interceptorClasses - the value to set
        Returns:
        the dsl builder

      • metadataMaxAgeMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder metadataMaxAgeMs​(long 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. The option is a: <code>long</code> type. Default: 5m Group: common
        Parameters:
        metadataMaxAgeMs - the value to set
        Returns:
        the dsl builder

      • metadataMaxAgeMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder metadataMaxAgeMs​(String 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. The option will be converted to a <code>long</code> type. Default: 5m Group: common
        Parameters:
        metadataMaxAgeMs - the value to set
        Returns:
        the dsl builder

      • metricReporters

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder metricReporters​(String 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. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        metricReporters - the value to set
        Returns:
        the dsl builder

      • metricsNumSamples

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder metricsNumSamples​(int metricsNumSamples)
        The number of samples maintained to compute metrics. The option is a: <code>int</code> type. Default: 2 Group: common
        Parameters:
        metricsNumSamples - the value to set
        Returns:
        the dsl builder

      • metricsSampleWindowMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder metricsSampleWindowMs​(long metricsSampleWindowMs)
        The window of time a metrics sample is computed over. The option is a: <code>long</code> type. Default: 30s Group: common
        Parameters:
        metricsSampleWindowMs - the value to set
        Returns:
        the dsl builder

      • metricsSampleWindowMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder metricsSampleWindowMs​(String metricsSampleWindowMs)
        The window of time a metrics sample is computed over. The option will be converted to a <code>long</code> type. Default: 30s Group: common
        Parameters:
        metricsSampleWindowMs - the value to set
        Returns:
        the dsl builder

      • partitionId

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder partitionId​(Integer 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. The option is a: <code>java.lang.Integer</code> type. Group: common
        Parameters:
        partitionId - the value to set
        Returns:
        the dsl builder

      • partitionId

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder partitionId​(String 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. The option will be converted to a <code>java.lang.Integer</code> type. Group: common
        Parameters:
        partitionId - the value to set
        Returns:
        the dsl builder

      • receiveBufferBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder receiveBufferBytes​(int 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. The option is a: <code>int</code> type. Default: 32768 Group: common
        Parameters:
        receiveBufferBytes - the value to set
        Returns:
        the dsl builder

      • receiveBufferBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder receiveBufferBytes​(String 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. The option will be converted to a <code>int</code> type. Default: 32768 Group: common
        Parameters:
        receiveBufferBytes - the value to set
        Returns:
        the dsl builder

      • reconnectBackoffMaxMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder reconnectBackoffMaxMs​(long 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. The option is a: <code>long</code> type. Default: 1s Group: common
        Parameters:
        reconnectBackoffMaxMs - the value to set
        Returns:
        the dsl builder

      • reconnectBackoffMaxMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder reconnectBackoffMaxMs​(String 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. The option will be converted to a <code>long</code> type. Default: 1s Group: common
        Parameters:
        reconnectBackoffMaxMs - the value to set
        Returns:
        the dsl builder

      • reconnectBackoffMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder reconnectBackoffMs​(long 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. The option is a: <code>long</code> type. Default: 50ms Group: common
        Parameters:
        reconnectBackoffMs - the value to set
        Returns:
        the dsl builder

      • reconnectBackoffMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder reconnectBackoffMs​(String 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. The option will be converted to a <code>long</code> type. Default: 50ms Group: common
        Parameters:
        reconnectBackoffMs - the value to set
        Returns:
        the dsl builder

      • requestTimeoutMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder requestTimeoutMs​(int 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. The option is a: <code>int</code> type. Default: 30s Group: common
        Parameters:
        requestTimeoutMs - the value to set
        Returns:
        the dsl builder

      • requestTimeoutMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder requestTimeoutMs​(String 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. The option will be converted to a <code>int</code> type. Default: 30s Group: common
        Parameters:
        requestTimeoutMs - the value to set
        Returns:
        the dsl builder

      • retryBackoffMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder retryBackoffMs​(long 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. The option is a: <code>long</code> type. Default: 100ms Group: common
        Parameters:
        retryBackoffMs - the value to set
        Returns:
        the dsl builder

      • retryBackoffMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder retryBackoffMs​(String 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. The option will be converted to a <code>long</code> type. Default: 100ms Group: common
        Parameters:
        retryBackoffMs - the value to set
        Returns:
        the dsl builder

      • sendBufferBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sendBufferBytes​(int 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. The option is a: <code>int</code> type. Default: 131072 Group: common
        Parameters:
        sendBufferBytes - the value to set
        Returns:
        the dsl builder

      • sendBufferBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sendBufferBytes​(String 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. The option will be converted to a <code>int</code> type. Default: 131072 Group: common
        Parameters:
        sendBufferBytes - the value to set
        Returns:
        the dsl builder

      • socketConnectionSetupTimeoutMaxMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder socketConnectionSetupTimeoutMaxMs​(long socketConnectionSetupTimeoutMaxMs)
        The maximum amount of time the client will wait for the socket connection to be established. The connection setup timeout will increase exponentially for each consecutive connection failure up to this maximum. To avoid connection storms, a randomization factor of 0.2 will be applied to the timeout resulting in a random range between 20% below and 20% above the computed value. The option is a: <code>long</code> type. Default: 30s Group: common
        Parameters:
        socketConnectionSetupTimeoutMaxMs - the value to set
        Returns:
        the dsl builder

      • socketConnectionSetupTimeoutMaxMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder socketConnectionSetupTimeoutMaxMs​(String socketConnectionSetupTimeoutMaxMs)
        The maximum amount of time the client will wait for the socket connection to be established. The connection setup timeout will increase exponentially for each consecutive connection failure up to this maximum. To avoid connection storms, a randomization factor of 0.2 will be applied to the timeout resulting in a random range between 20% below and 20% above the computed value. The option will be converted to a <code>long</code> type. Default: 30s Group: common
        Parameters:
        socketConnectionSetupTimeoutMaxMs - the value to set
        Returns:
        the dsl builder

      • socketConnectionSetupTimeoutMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder socketConnectionSetupTimeoutMs​(long socketConnectionSetupTimeoutMs)
        The amount of time the client will wait for the socket connection to be established. If the connection is not built before the timeout elapses, clients will close the socket channel. The option is a: <code>long</code> type. Default: 10s Group: common
        Parameters:
        socketConnectionSetupTimeoutMs - the value to set
        Returns:
        the dsl builder

      • socketConnectionSetupTimeoutMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder socketConnectionSetupTimeoutMs​(String socketConnectionSetupTimeoutMs)
        The amount of time the client will wait for the socket connection to be established. If the connection is not built before the timeout elapses, clients will close the socket channel. The option will be converted to a <code>long</code> type. Default: 10s Group: common
        Parameters:
        socketConnectionSetupTimeoutMs - the value to set
        Returns:
        the dsl builder

      • allowAutoCreateTopics

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder allowAutoCreateTopics​(boolean 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. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        allowAutoCreateTopics - the value to set
        Returns:
        the dsl builder

      • allowAutoCreateTopics

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder allowAutoCreateTopics​(String 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. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        allowAutoCreateTopics - the value to set
        Returns:
        the dsl builder

      • allowManualCommit

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder allowManualCommit​(boolean allowManualCommit)
        Whether to allow doing manual commits via org.apache.camel.component.vertx.kafka.offset.VertxKafkaManualCommit. If this option is enabled then an instance of org.apache.camel.component.vertx.kafka.offset.VertxKafkaManualCommit is stored on the Exchange message header, which allows end users to access this API and perform manual offset commits via the Kafka consumer. Note: To take full control of the offset committing, you may need to disable the Kafka Consumer default auto commit behavior by setting 'enableAutoCommit' to 'false'. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        allowManualCommit - the value to set
        Returns:
        the dsl builder

      • allowManualCommit

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder allowManualCommit​(String allowManualCommit)
        Whether to allow doing manual commits via org.apache.camel.component.vertx.kafka.offset.VertxKafkaManualCommit. If this option is enabled then an instance of org.apache.camel.component.vertx.kafka.offset.VertxKafkaManualCommit is stored on the Exchange message header, which allows end users to access this API and perform manual offset commits via the Kafka consumer. Note: To take full control of the offset committing, you may need to disable the Kafka Consumer default auto commit behavior by setting 'enableAutoCommit' to 'false'. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        allowManualCommit - the value to set
        Returns:
        the dsl builder

      • autoCommitIntervalMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder autoCommitIntervalMs​(int autoCommitIntervalMs)
        The frequency in milliseconds that the consumer offsets are auto-committed to Kafka if enable.auto.commit is set to true. The option is a: <code>int</code> type. Default: 5s Group: consumer
        Parameters:
        autoCommitIntervalMs - the value to set
        Returns:
        the dsl builder

      • autoCommitIntervalMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder autoCommitIntervalMs​(String autoCommitIntervalMs)
        The frequency in milliseconds that the consumer offsets are auto-committed to Kafka if enable.auto.commit is set to true. The option will be converted to a <code>int</code> type. Default: 5s Group: consumer
        Parameters:
        autoCommitIntervalMs - the value to set
        Returns:
        the dsl builder

      • autoOffsetReset

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder autoOffsetReset​(String 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. The option is a: <code>java.lang.String</code> type. Default: latest Group: consumer
        Parameters:
        autoOffsetReset - the value to set
        Returns:
        the dsl builder

      • checkCrcs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder checkCrcs​(boolean 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. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        checkCrcs - the value to set
        Returns:
        the dsl builder

      • checkCrcs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder checkCrcs​(String 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. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        checkCrcs - the value to set
        Returns:
        the dsl builder

      • clientRack

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder clientRack​(String 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'. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        clientRack - the value to set
        Returns:
        the dsl builder

      • defaultApiTimeoutMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder defaultApiTimeoutMs​(int 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. The option is a: <code>int</code> type. Default: 1m Group: consumer
        Parameters:
        defaultApiTimeoutMs - the value to set
        Returns:
        the dsl builder

      • defaultApiTimeoutMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder defaultApiTimeoutMs​(String 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. The option will be converted to a <code>int</code> type. Default: 1m Group: consumer
        Parameters:
        defaultApiTimeoutMs - the value to set
        Returns:
        the dsl builder

      • enableAutoCommit

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder enableAutoCommit​(boolean enableAutoCommit)
        If true the consumer's offset will be periodically committed in the background. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        enableAutoCommit - the value to set
        Returns:
        the dsl builder

      • enableAutoCommit

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder enableAutoCommit​(String enableAutoCommit)
        If true the consumer's offset will be periodically committed in the background. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        enableAutoCommit - the value to set
        Returns:
        the dsl builder

      • excludeInternalTopics

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder excludeInternalTopics​(boolean 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. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        excludeInternalTopics - the value to set
        Returns:
        the dsl builder

      • excludeInternalTopics

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder excludeInternalTopics​(String 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. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        excludeInternalTopics - the value to set
        Returns:
        the dsl builder

      • fetchMaxBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder fetchMaxBytes​(int 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. The option is a: <code>int</code> type. Default: 52428800 Group: consumer
        Parameters:
        fetchMaxBytes - the value to set
        Returns:
        the dsl builder

      • fetchMaxBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder fetchMaxBytes​(String 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. The option will be converted to a <code>int</code> type. Default: 52428800 Group: consumer
        Parameters:
        fetchMaxBytes - the value to set
        Returns:
        the dsl builder

      • fetchMaxWaitMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder fetchMaxWaitMs​(int 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. The option is a: <code>int</code> type. Default: 500ms Group: consumer
        Parameters:
        fetchMaxWaitMs - the value to set
        Returns:
        the dsl builder

      • fetchMaxWaitMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder fetchMaxWaitMs​(String 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. The option will be converted to a <code>int</code> type. Default: 500ms Group: consumer
        Parameters:
        fetchMaxWaitMs - the value to set
        Returns:
        the dsl builder

      • fetchMinBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder fetchMinBytes​(int 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. The option is a: <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        fetchMinBytes - the value to set
        Returns:
        the dsl builder

      • fetchMinBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder fetchMinBytes​(String 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. The option will be converted to a <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        fetchMinBytes - the value to set
        Returns:
        the dsl builder

      • groupId

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder groupId​(String 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. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        groupId - the value to set
        Returns:
        the dsl builder

      • groupInstanceId

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder groupInstanceId​(String 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. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        groupInstanceId - the value to set
        Returns:
        the dsl builder

      • heartbeatIntervalMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder heartbeatIntervalMs​(int 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. The option is a: <code>int</code> type. Default: 3s Group: consumer
        Parameters:
        heartbeatIntervalMs - the value to set
        Returns:
        the dsl builder

      • heartbeatIntervalMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder heartbeatIntervalMs​(String 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. The option will be converted to a <code>int</code> type. Default: 3s Group: consumer
        Parameters:
        heartbeatIntervalMs - the value to set
        Returns:
        the dsl builder

      • isolationLevel

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder isolationLevel​(String 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. The option is a: <code>java.lang.String</code> type. Default: read_uncommitted Group: consumer
        Parameters:
        isolationLevel - the value to set
        Returns:
        the dsl builder

      • keyDeserializer

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder keyDeserializer​(String keyDeserializer)
        Deserializer class for key that implements the org.apache.kafka.common.serialization.Deserializer interface. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.common.serialization.StringDeserializer Group: consumer
        Parameters:
        keyDeserializer - the value to set
        Returns:
        the dsl builder

      • maxPartitionFetchBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder maxPartitionFetchBytes​(int 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. The option is a: <code>int</code> type. Default: 1048576 Group: consumer
        Parameters:
        maxPartitionFetchBytes - the value to set
        Returns:
        the dsl builder

      • maxPartitionFetchBytes

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder maxPartitionFetchBytes​(String 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. The option will be converted to a <code>int</code> type. Default: 1048576 Group: consumer
        Parameters:
        maxPartitionFetchBytes - the value to set
        Returns:
        the dsl builder

      • maxPollIntervalMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder maxPollIntervalMs​(int 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. The option is a: <code>int</code> type. Default: 5m Group: consumer
        Parameters:
        maxPollIntervalMs - the value to set
        Returns:
        the dsl builder

      • maxPollIntervalMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder maxPollIntervalMs​(String 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. The option will be converted to a <code>int</code> type. Default: 5m Group: consumer
        Parameters:
        maxPollIntervalMs - the value to set
        Returns:
        the dsl builder

      • maxPollRecords

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder maxPollRecords​(int maxPollRecords)
        The maximum number of records returned in a single call to poll(). Note, that max.poll.records does not impact the underlying fetching behavior. The consumer will cache the records from each fetch request and returns them incrementally from each poll. The option is a: <code>int</code> type. Default: 500 Group: consumer
        Parameters:
        maxPollRecords - the value to set
        Returns:
        the dsl builder

      • maxPollRecords

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder maxPollRecords​(String maxPollRecords)
        The maximum number of records returned in a single call to poll(). Note, that max.poll.records does not impact the underlying fetching behavior. The consumer will cache the records from each fetch request and returns them incrementally from each poll. The option will be converted to a <code>int</code> type. Default: 500 Group: consumer
        Parameters:
        maxPollRecords - the value to set
        Returns:
        the dsl builder

      • partitionAssignmentStrategy

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder partitionAssignmentStrategy​(String 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. Available options are:org.apache.kafka.clients.consumer.RangeAssignor: The default assignor, which works on a per-topic basis.org.apache.kafka.clients.consumer.RoundRobinAssignor: Assigns partitions to consumers in a round-robin fashion.org.apache.kafka.clients.consumer.StickyAssignor: Guarantees an assignment that is maximally balanced while preserving as many existing partition assignments as possible.org.apache.kafka.clients.consumer.CooperativeStickyAssignor: Follows the same StickyAssignor logic, but allows for cooperative rebalancing.Implementing the org.apache.kafka.clients.consumer.ConsumerPartitionAssignor interface allows you to plug in a custom assignment strategy. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.clients.consumer.RangeAssignor Group: consumer
        Parameters:
        partitionAssignmentStrategy - the value to set
        Returns:
        the dsl builder

      • seekToOffset

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder seekToOffset​(Long seekToOffset)
        Set if KafkaConsumer will read from a particular offset on startup. This config will take precedence over seekTo config. The option is a: <code>java.lang.Long</code> type. Group: consumer
        Parameters:
        seekToOffset - the value to set
        Returns:
        the dsl builder

      • seekToOffset

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder seekToOffset​(String seekToOffset)
        Set if KafkaConsumer will read from a particular offset on startup. This config will take precedence over seekTo config. The option will be converted to a <code>java.lang.Long</code> type. Group: consumer
        Parameters:
        seekToOffset - the value to set
        Returns:
        the dsl builder

      • seekToPosition

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder seekToPosition​(String seekToPosition)
        Set if KafkaConsumer will read from beginning or end on startup: beginning : read from beginning end : read from end. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        seekToPosition - the value to set
        Returns:
        the dsl builder

      • sessionTimeoutMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sessionTimeoutMs​(int 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. The option is a: <code>int</code> type. Default: 10s Group: consumer
        Parameters:
        sessionTimeoutMs - the value to set
        Returns:
        the dsl builder

      • sessionTimeoutMs

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sessionTimeoutMs​(String 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. The option will be converted to a <code>int</code> type. Default: 10s Group: consumer
        Parameters:
        sessionTimeoutMs - the value to set
        Returns:
        the dsl builder

      • valueDeserializer

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder valueDeserializer​(String valueDeserializer)
        Deserializer class for value that implements the org.apache.kafka.common.serialization.Deserializer interface. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.common.serialization.StringDeserializer Group: consumer
        Parameters:
        valueDeserializer - the value to set
        Returns:
        the dsl builder

      • saslClientCallbackHandlerClass

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslClientCallbackHandlerClass​(String saslClientCallbackHandlerClass)
        The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        saslClientCallbackHandlerClass - the value to set
        Returns:
        the dsl builder

      • saslJaasConfig

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslJaasConfig​(String 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;. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        saslJaasConfig - the value to set
        Returns:
        the dsl builder

      • saslKerberosMinTimeBeforeRelogin

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslKerberosMinTimeBeforeRelogin​(long saslKerberosMinTimeBeforeRelogin)
        Login thread sleep time between refresh attempts. The option is a: <code>long</code> type. Default: 60000 Group: security
        Parameters:
        saslKerberosMinTimeBeforeRelogin - the value to set
        Returns:
        the dsl builder

      • saslKerberosMinTimeBeforeRelogin

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslKerberosMinTimeBeforeRelogin​(String saslKerberosMinTimeBeforeRelogin)
        Login thread sleep time between refresh attempts. The option will be converted to a <code>long</code> type. Default: 60000 Group: security
        Parameters:
        saslKerberosMinTimeBeforeRelogin - the value to set
        Returns:
        the dsl builder

      • saslKerberosServiceName

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslKerberosServiceName​(String saslKerberosServiceName)
        The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        saslKerberosServiceName - the value to set
        Returns:
        the dsl builder

      • saslKerberosTicketRenewJitter

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslKerberosTicketRenewJitter​(double saslKerberosTicketRenewJitter)
        Percentage of random jitter added to the renewal time. The option is a: <code>double</code> type. Default: 0.05 Group: security
        Parameters:
        saslKerberosTicketRenewJitter - the value to set
        Returns:
        the dsl builder

      • saslKerberosTicketRenewJitter

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslKerberosTicketRenewJitter​(String saslKerberosTicketRenewJitter)
        Percentage of random jitter added to the renewal time. The option will be converted to a <code>double</code> type. Default: 0.05 Group: security
        Parameters:
        saslKerberosTicketRenewJitter - the value to set
        Returns:
        the dsl builder

      • saslKerberosTicketRenewWindowFactor

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslKerberosTicketRenewWindowFactor​(double saslKerberosTicketRenewWindowFactor)
        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. The option is a: <code>double</code> type. Default: 0.8 Group: security
        Parameters:
        saslKerberosTicketRenewWindowFactor - the value to set
        Returns:
        the dsl builder

      • saslKerberosTicketRenewWindowFactor

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslKerberosTicketRenewWindowFactor​(String saslKerberosTicketRenewWindowFactor)
        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. The option will be converted to a <code>double</code> type. Default: 0.8 Group: security
        Parameters:
        saslKerberosTicketRenewWindowFactor - the value to set
        Returns:
        the dsl builder

      • saslLoginCallbackHandlerClass

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginCallbackHandlerClass​(String saslLoginCallbackHandlerClass)
        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. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        saslLoginCallbackHandlerClass - the value to set
        Returns:
        the dsl builder

      • saslLoginClass

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginClass​(String 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. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        saslLoginClass - the value to set
        Returns:
        the dsl builder

      • saslLoginRefreshBufferSeconds

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginRefreshBufferSeconds​(short saslLoginRefreshBufferSeconds)
        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. The option is a: <code>short</code> type. Default: 300 Group: security
        Parameters:
        saslLoginRefreshBufferSeconds - the value to set
        Returns:
        the dsl builder

      • saslLoginRefreshBufferSeconds

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginRefreshBufferSeconds​(String saslLoginRefreshBufferSeconds)
        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. The option will be converted to a <code>short</code> type. Default: 300 Group: security
        Parameters:
        saslLoginRefreshBufferSeconds - the value to set
        Returns:
        the dsl builder

      • saslLoginRefreshMinPeriodSeconds

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginRefreshMinPeriodSeconds​(short saslLoginRefreshMinPeriodSeconds)
        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. The option is a: <code>short</code> type. Default: 60 Group: security
        Parameters:
        saslLoginRefreshMinPeriodSeconds - the value to set
        Returns:
        the dsl builder

      • saslLoginRefreshMinPeriodSeconds

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginRefreshMinPeriodSeconds​(String saslLoginRefreshMinPeriodSeconds)
        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. The option will be converted to a <code>short</code> type. Default: 60 Group: security
        Parameters:
        saslLoginRefreshMinPeriodSeconds - the value to set
        Returns:
        the dsl builder

      • saslLoginRefreshWindowFactor

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginRefreshWindowFactor​(double 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. The option is a: <code>double</code> type. Default: 0.8 Group: security
        Parameters:
        saslLoginRefreshWindowFactor - the value to set
        Returns:
        the dsl builder

      • saslLoginRefreshWindowFactor

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginRefreshWindowFactor​(String 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. The option will be converted to a <code>double</code> type. Default: 0.8 Group: security
        Parameters:
        saslLoginRefreshWindowFactor - the value to set
        Returns:
        the dsl builder

      • saslLoginRefreshWindowJitter

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginRefreshWindowJitter​(double 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. The option is a: <code>double</code> type. Default: 0.05 Group: security
        Parameters:
        saslLoginRefreshWindowJitter - the value to set
        Returns:
        the dsl builder

      • saslLoginRefreshWindowJitter

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslLoginRefreshWindowJitter​(String 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. The option will be converted to a <code>double</code> type. Default: 0.05 Group: security
        Parameters:
        saslLoginRefreshWindowJitter - the value to set
        Returns:
        the dsl builder

      • saslMechanism

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder saslMechanism​(String saslMechanism)
        SASL mechanism used for client connections. This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism. The option is a: <code>java.lang.String</code> type. Default: GSSAPI Group: security
        Parameters:
        saslMechanism - the value to set
        Returns:
        the dsl builder

      • securityProtocol

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder securityProtocol​(String securityProtocol)
        Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. The option is a: <code>java.lang.String</code> type. Default: PLAINTEXT Group: security
        Parameters:
        securityProtocol - the value to set
        Returns:
        the dsl builder

      • securityProviders

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder securityProviders​(String 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. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        securityProviders - the value to set
        Returns:
        the dsl builder

      • sslCipherSuites

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslCipherSuites​(String 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. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslCipherSuites - the value to set
        Returns:
        the dsl builder

      • sslEnabledProtocols

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslEnabledProtocols​(String 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. The option is a: <code>java.lang.String</code> type. Default: TLSv1.2,TLSv1.3 Group: security
        Parameters:
        sslEnabledProtocols - the value to set
        Returns:
        the dsl builder

      • sslEndpointIdentificationAlgorithm

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslEndpointIdentificationAlgorithm​(String sslEndpointIdentificationAlgorithm)
        The endpoint identification algorithm to validate server hostname using server certificate. The option is a: <code>java.lang.String</code> type. Default: https Group: security
        Parameters:
        sslEndpointIdentificationAlgorithm - the value to set
        Returns:
        the dsl builder

      • sslEngineFactoryClass

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslEngineFactoryClass​(String 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. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslEngineFactoryClass - the value to set
        Returns:
        the dsl builder

      • sslKeymanagerAlgorithm

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslKeymanagerAlgorithm​(String 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. The option is a: <code>java.lang.String</code> type. Default: SunX509 Group: security
        Parameters:
        sslKeymanagerAlgorithm - the value to set
        Returns:
        the dsl builder

      • sslKeyPassword

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslKeyPassword​(String sslKeyPassword)
        The password of the private key in the key store file orthe PEM key specified in ssl.keystore.key'. This is required for clients only if two-way authentication is configured. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslKeyPassword - the value to set
        Returns:
        the dsl builder

      • sslKeystoreCertificateChain

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslKeystoreCertificateChain​(String sslKeystoreCertificateChain)
        Certificate chain in the format specified by 'ssl.keystore.type'. Default SSL engine factory supports only PEM format with a list of X.509 certificates. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslKeystoreCertificateChain - the value to set
        Returns:
        the dsl builder

      • sslKeystoreKey

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslKeystoreKey​(String sslKeystoreKey)
        Private key in the format specified by 'ssl.keystore.type'. Default SSL engine factory supports only PEM format with PKCS#8 keys. If the key is encrypted, key password must be specified using 'ssl.key.password'. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslKeystoreKey - the value to set
        Returns:
        the dsl builder

      • sslKeystoreLocation

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslKeystoreLocation​(String sslKeystoreLocation)
        The location of the key store file. This is optional for client and can be used for two-way authentication for client. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslKeystoreLocation - the value to set
        Returns:
        the dsl builder

      • sslKeystorePassword

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslKeystorePassword​(String sslKeystorePassword)
        The store password for the key store file. This is optional for client and only needed if 'ssl.keystore.location' is configured. Key store password is not supported for PEM format. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslKeystorePassword - the value to set
        Returns:
        the dsl builder

      • sslKeystoreType

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslKeystoreType​(String sslKeystoreType)
        The file format of the key store file. This is optional for client. The option is a: <code>java.lang.String</code> type. Default: JKS Group: security
        Parameters:
        sslKeystoreType - the value to set
        Returns:
        the dsl builder

      • sslProtocol

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslProtocol​(String 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'. The option is a: <code>java.lang.String</code> type. Default: TLSv1.2 Group: security
        Parameters:
        sslProtocol - the value to set
        Returns:
        the dsl builder

      • sslProvider

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslProvider​(String sslProvider)
        The name of the security provider used for SSL connections. Default value is the default security provider of the JVM. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslProvider - the value to set
        Returns:
        the dsl builder

      • sslSecureRandomImplementation

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslSecureRandomImplementation​(String sslSecureRandomImplementation)
        The SecureRandom PRNG implementation to use for SSL cryptography operations. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslSecureRandomImplementation - the value to set
        Returns:
        the dsl builder

      • sslTrustmanagerAlgorithm

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslTrustmanagerAlgorithm​(String 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. The option is a: <code>java.lang.String</code> type. Default: PKIX Group: security
        Parameters:
        sslTrustmanagerAlgorithm - the value to set
        Returns:
        the dsl builder

      • sslTruststoreCertificates

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslTruststoreCertificates​(String sslTruststoreCertificates)
        Trusted certificates in the format specified by 'ssl.truststore.type'. Default SSL engine factory supports only PEM format with X.509 certificates. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslTruststoreCertificates - the value to set
        Returns:
        the dsl builder

      • sslTruststorePassword

        default VertxKafkaEndpointBuilderFactory.VertxKafkaEndpointConsumerBuilder sslTruststorePassword​(String sslTruststorePassword)
        The password for the trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled. Trust store password is not supported for PEM format. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        sslTruststorePassword - the value to set
        Returns:
        the dsl builder