Package org.swisspush.kobuka.client

Class ProducerConfigBuilder

java.lang.Object
org.swisspush.kobuka.client.base.BaseProducerConfigBuilder<ProducerConfigBuilder>
org.swisspush.kobuka.client.ProducerConfigBuilder
All Implemented Interfaces:
ProducerConfigFields<ProducerConfigBuilder>
public class ProducerConfigBuilder extends BaseProducerConfigBuilder<ProducerConfigBuilder>

  • Constructor Details

  • Method Details

    • build

      default <R> R build(Function<Map<String,Object>,R> fn)

    • property

      default ProducerConfigBuilder property(String key, Object value)

    • asSupplier

      default Supplier<Map<String,Object>> asSupplier()

    • bootstrapServers

      public ProducerConfigBuilder bootstrapServers(List<String> value)
      Description copied from interface: ProducerConfigFields

      bootstrap.servers

      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—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).

      Default: ""

      Valid Values: non-null string

      Importance: high

      Specified by:
      bootstrapServers in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • bootstrapServers

      public ProducerConfigBuilder bootstrapServers(String value)
      Description copied from interface: ProducerConfigFields

      bootstrap.servers

      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—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).

      Default: ""

      Valid Values: non-null string

      Importance: high

      Specified by:
      bootstrapServers in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • clientDnsLookup

      public ProducerConfigBuilder clientDnsLookup(String value)
      Description copied from interface: ProducerConfigFields

      client.dns.lookup

      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.

      Default: use_all_dns_ips

      Valid Values: [use_all_dns_ips, resolve_canonical_bootstrap_servers_only]

      Importance: medium

      Specified by:
      clientDnsLookup in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • bufferMemory

      public ProducerConfigBuilder bufferMemory(Long value)
      Description copied from interface: ProducerConfigFields

      buffer.memory

      The total bytes of memory the producer can use to buffer records waiting to be sent to the server.
      If records are sent faster than they can be delivered to the server the producer will block for max.block.ms after which it will throw an exception.

      This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering.
      Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests.

      Default: 33554432

      Valid Values: [0,...]

      Importance: high

      Specified by:
      bufferMemory in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • retries

      public ProducerConfigBuilder retries(Integer value)
      Description copied from interface: ProducerConfigFields

      retries

      Setting a value greater than zero will cause the client to resend any record whose send fails with a potentially transient error.
      Note that this retry is no different than if the client resent the record upon receiving the error.
      Produce requests will be failed before the number of retries has been exhausted if the timeout configured by delivery.timeout.ms expires first before successful acknowledgement.
      Users should generally prefer to leave this config unset and instead use delivery.timeout.ms to control retry behavior.

      Enabling idempotence requires this config value to be greater than 0.
      If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled.

      Allowing retries while setting enable.idempotence to false and max.in.flight.requests.per.connection to 1 will potentially change the ordering of records because if two batches are sent to a single partition, and the first fails and is retried but the second succeeds, then the records in the second batch may appear first.

      Default: 2147483647

      Valid Values: [0,...,2147483647]

      Importance: high

      Specified by:
      retries in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • acks

      public ProducerConfigBuilder acks(String value)
      Description copied from interface: ProducerConfigFields

      acks

      The number of acknowledgments the producer requires the leader to have received before considering a request complete.
      This controls the durability of records that are sent.
      The following settings are allowed:
      • acks=0 If set to zero then the producer will not wait for any acknowledgment from the server at all.
        The record will be immediately added to the socket buffer and considered sent.
        No guarantee can be made that the server has received the record in this case, and the retries configuration will not take effect (as the client won't generally know of any failures).
        The offset given back for each record will always be set to -1.
      • acks=1 This will mean the leader will write the record to its local log but will respond without awaiting full acknowledgement from all followers.
        In this case should the leader fail immediately after acknowledging the record but before the followers have replicated it then the record will be lost.
      • acks=all This means the leader will wait for the full set of in-sync replicas to acknowledge the record.
        This guarantees that the record will not be lost as long as at least one in-sync replica remains alive.
        This is the strongest available guarantee.
        This is equivalent to the acks=-1 setting.

      Note that enabling idempotence requires this config value to be 'all'.
      If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled.

      Default: all

      Valid Values: [all, -1, 0, 1]

      Importance: low

      Specified by:
      acks in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • compressionType

      public ProducerConfigBuilder compressionType(String value)
      Description copied from interface: ProducerConfigFields

      compression.type

      The compression type for all data generated by the producer.
      The default is none (i.e.
      no compression).
      Valid values are none, gzip, snappy, lz4, or zstd.
      Compression is of full batches of data, so the efficacy of batching will also impact the compression ratio (more batching means better compression).

      Default: none

      Valid Values: [none, gzip, snappy, lz4, zstd]

      Importance: high

      Specified by:
      compressionType in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • batchSize

      public ProducerConfigBuilder batchSize(Integer value)
      Description copied from interface: ProducerConfigFields

      batch.size

      The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition.
      This helps performance on both the client and the server.
      This configuration controls the default batch size in bytes.

      No attempt will be made to batch records larger than this size.

      Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent.

      A small batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely).
      A very large batch size may use memory a bit more wastefully as we will always allocate a buffer of the specified batch size in anticipation of additional records.

      Note: This setting gives the upper bound of the batch size to be sent.
      If we have fewer than this many bytes accumulated for this partition, we will 'linger' for the linger.ms time waiting for more records to show up.
      This linger.ms setting defaults to 0, which means we'll immediately send out a record even the accumulated batch size is under this batch.size setting.

      Default: 16384

      Valid Values: [0,...]

      Importance: medium

      Specified by:
      batchSize in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • partitionerAdaptivePartitioningEnable

      public ProducerConfigBuilder partitionerAdaptivePartitioningEnable(Boolean value)
      Description copied from interface: ProducerConfigFields

      partitioner.adaptive.partitioning.enable

      When set to 'true', the producer will try to adapt to broker performance and produce more messages to partitions hosted on faster brokers.
      If 'false', producer will try to distribute messages uniformly.
      Note: this setting has no effect if a custom partitioner is used

      Default: true

      Valid Values:

      Importance: low

      Specified by:
      partitionerAdaptivePartitioningEnable in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • partitionerAvailabilityTimeoutMs

      public ProducerConfigBuilder partitionerAvailabilityTimeoutMs(Long value)
      Description copied from interface: ProducerConfigFields

      partitioner.availability.timeout.ms

      If a broker cannot process produce requests from a partition for partitioner.availability.timeout.ms time, the partitioner treats that partition as not available.
      If the value is 0, this logic is disabled.
      Note: this setting has no effect if a custom partitioner is used or partitioner.adaptive.partitioning.enable is set to 'false'

      Default: 0

      Valid Values: [0,...]

      Importance: low

      Specified by:
      partitionerAvailabilityTimeoutMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • partitionerIgnoreKeys

      public ProducerConfigBuilder partitionerIgnoreKeys(Boolean value)
      Description copied from interface: ProducerConfigFields

      partitioner.ignore.keys

      When set to 'true' the producer won't use record keys to choose a partition.
      If 'false', producer would choose a partition based on a hash of the key when a key is present.
      Note: this setting has no effect if a custom partitioner is used.

      Default: false

      Valid Values:

      Importance: medium

      Specified by:
      partitionerIgnoreKeys in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • lingerMs

      public ProducerConfigBuilder lingerMs(Long value)
      Description copied from interface: ProducerConfigFields

      linger.ms

      The producer groups together any records that arrive in between request transmissions into a single batched request.
      Normally this occurs only under load when records arrive faster than they can be sent out.
      However in some circumstances the client may want to reduce the number of requests even under moderate load.
      This setting accomplishes this by adding a small amount of artificial delay—that is, rather than immediately sending out a record, the producer will wait for up to the given delay to allow other records to be sent so that the sends can be batched together.
      This can be thought of as analogous to Nagle's algorithm in TCP.
      This setting gives the upper bound on the delay for batching: once we get batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if we have fewer than this many bytes accumulated for this partition we will 'linger' for the specified time waiting for more records to show up.
      This setting defaults to 0 (i.e.
      no delay).
      Setting linger.ms=5, for example, would have the effect of reducing the number of requests sent but would add up to 5ms of latency to records sent in the absence of load.

      Default: 0

      Valid Values: [0,...]

      Importance: medium

      Specified by:
      lingerMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • deliveryTimeoutMs

      public ProducerConfigBuilder deliveryTimeoutMs(Integer value)
      Description copied from interface: ProducerConfigFields

      delivery.timeout.ms

      An upper bound on the time to report success or failure after a call to send() returns.
      This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures.
      The producer may report failure to send a record earlier than this config if either an unrecoverable error is encountered, the retries have been exhausted, or the record is added to a batch which reached an earlier delivery expiration deadline.
      The value of this config should be greater than or equal to the sum of request.timeout.ms and linger.ms.

      Default: 120000 (2 minutes)

      Valid Values: [0,...]

      Importance: medium

      Specified by:
      deliveryTimeoutMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • clientId

      public ProducerConfigBuilder clientId(String value)
      Description copied from interface: ProducerConfigFields

      client.id

      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.

      Default: ""

      Valid Values:

      Importance: medium

      Specified by:
      clientId in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sendBufferBytes

      public ProducerConfigBuilder sendBufferBytes(Integer value)
      Description copied from interface: ProducerConfigFields

      send.buffer.bytes

      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.

      Default: 131072 (128 kibibytes)

      Valid Values: [-1,...]

      Importance: medium

      Specified by:
      sendBufferBytes in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • receiveBufferBytes

      public ProducerConfigBuilder receiveBufferBytes(Integer value)
      Description copied from interface: ProducerConfigFields

      receive.buffer.bytes

      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.

      Default: 32768 (32 kibibytes)

      Valid Values: [-1,...]

      Importance: medium

      Specified by:
      receiveBufferBytes in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • maxRequestSize

      public ProducerConfigBuilder maxRequestSize(Integer value)
      Description copied from interface: ProducerConfigFields

      max.request.size

      The maximum size of a request in bytes.
      This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.
      This is also effectively a cap on the maximum uncompressed record batch size.
      Note that the server has its own cap on the record batch size (after compression if compression is enabled) which may be different from this.

      Default: 1048576

      Valid Values: [0,...]

      Importance: medium

      Specified by:
      maxRequestSize in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • reconnectBackoffMs

      public ProducerConfigBuilder reconnectBackoffMs(Long value)
      Description copied from interface: ProducerConfigFields

      reconnect.backoff.ms

      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.

      Default: 50

      Valid Values: [0,...]

      Importance: low

      Specified by:
      reconnectBackoffMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • reconnectBackoffMaxMs

      public ProducerConfigBuilder reconnectBackoffMaxMs(Long value)
      Description copied from interface: ProducerConfigFields

      reconnect.backoff.max.ms

      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.

      Default: 1000 (1 second)

      Valid Values: [0,...]

      Importance: low

      Specified by:
      reconnectBackoffMaxMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • retryBackoffMs

      public ProducerConfigBuilder retryBackoffMs(Long value)
      Description copied from interface: ProducerConfigFields

      retry.backoff.ms

      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.

      Default: 100

      Valid Values: [0,...]

      Importance: low

      Specified by:
      retryBackoffMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • maxBlockMs

      public ProducerConfigBuilder maxBlockMs(Long value)
      Description copied from interface: ProducerConfigFields

      max.block.ms

      The configuration controls how long the KafkaProducer's send(), partitionsFor(), initTransactions(), sendOffsetsToTransaction(), commitTransaction() and abortTransaction() methods will block.
      For send() this timeout bounds the total time waiting for both metadata fetch and buffer allocation (blocking in the user-supplied serializers or partitioner is not counted against this timeout).
      For partitionsFor() this timeout bounds the time spent waiting for metadata if it is unavailable.
      The transaction-related methods always block, but may timeout if the transaction coordinator could not be discovered or did not respond within the timeout.

      Default: 60000 (1 minute)

      Valid Values: [0,...]

      Importance: medium

      Specified by:
      maxBlockMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • requestTimeoutMs

      public ProducerConfigBuilder requestTimeoutMs(Integer value)
      Description copied from interface: ProducerConfigFields

      request.timeout.ms

      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.

      Default: 30000 (30 seconds)

      Valid Values: [0,...]

      Importance: medium

      Specified by:
      requestTimeoutMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • metadataMaxAgeMs

      public ProducerConfigBuilder metadataMaxAgeMs(Long value)
      Description copied from interface: ProducerConfigFields

      metadata.max.age.ms

      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.

      Default: 300000 (5 minutes)

      Valid Values: [0,...]

      Importance: low

      Specified by:
      metadataMaxAgeMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • metadataMaxIdleMs

      public ProducerConfigBuilder metadataMaxIdleMs(Long value)
      Description copied from interface: ProducerConfigFields

      metadata.max.idle.ms

      Controls how long the producer will cache metadata for a topic that's idle.
      If the elapsed time since a topic was last produced to exceeds the metadata idle duration, then the topic's metadata is forgotten and the next access to it will force a metadata fetch request.

      Default: 300000 (5 minutes)

      Valid Values: [5000,...]

      Importance: low

      Specified by:
      metadataMaxIdleMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • metricsSampleWindowMs

      public ProducerConfigBuilder metricsSampleWindowMs(Long value)
      Description copied from interface: ProducerConfigFields

      metrics.sample.window.ms

      The window of time a metrics sample is computed over.

      Default: 30000 (30 seconds)

      Valid Values: [0,...]

      Importance: low

      Specified by:
      metricsSampleWindowMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • metricsNumSamples

      public ProducerConfigBuilder metricsNumSamples(Integer value)
      Description copied from interface: ProducerConfigFields

      metrics.num.samples

      The number of samples maintained to compute metrics.

      Default: 2

      Valid Values: [1,...]

      Importance: low

      Specified by:
      metricsNumSamples in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • metricsRecordingLevel

      public ProducerConfigBuilder metricsRecordingLevel(String value)
      Description copied from interface: ProducerConfigFields

      metrics.recording.level

      The highest recording level for metrics.

      Default: INFO

      Valid Values: [INFO, DEBUG, TRACE]

      Importance: low

      Specified by:
      metricsRecordingLevel in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • metricReporters

      public ProducerConfigBuilder metricReporters(List<String> value)
      Description copied from interface: ProducerConfigFields

      metric.reporters

      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.

      Default: ""

      Valid Values: non-null string

      Importance: low

      Specified by:
      metricReporters in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • metricReporters

      public ProducerConfigBuilder metricReporters(String value)
      Description copied from interface: ProducerConfigFields

      metric.reporters

      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.

      Default: ""

      Valid Values: non-null string

      Importance: low

      Specified by:
      metricReporters in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • maxInFlightRequestsPerConnection

      public ProducerConfigBuilder maxInFlightRequestsPerConnection(Integer value)
      Description copied from interface: ProducerConfigFields

      max.in.flight.requests.per.connection

      The maximum number of unacknowledged requests the client will send on a single connection before blocking.
      Note that if this configuration is set to be greater than 1 and enable.idempotence is set to false, there is a risk of message reordering after a failed send due to retries (i.e., if retries are enabled); if retries are disabled or if enable.idempotence is set to true, ordering will be preserved.
      Additionally, enabling idempotence requires the value of this configuration to be less than or equal to 5.
      If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled.

      Default: 5

      Valid Values: [1,...]

      Importance: low

      Specified by:
      maxInFlightRequestsPerConnection in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • keySerializer

      public ProducerConfigBuilder keySerializer(Class value)
      Description copied from interface: ProducerConfigFields

      key.serializer

      Serializer class for key that implements the org.apache.kafka.common.serialization.Serializer interface.

      Default:

      Valid Values:

      Importance: high

      Specified by:
      keySerializer in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • valueSerializer

      public ProducerConfigBuilder valueSerializer(Class value)
      Description copied from interface: ProducerConfigFields

      value.serializer

      Serializer class for value that implements the org.apache.kafka.common.serialization.Serializer interface.

      Default:

      Valid Values:

      Importance: high

      Specified by:
      valueSerializer in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • socketConnectionSetupTimeoutMs

      public ProducerConfigBuilder socketConnectionSetupTimeoutMs(Long value)
      Description copied from interface: ProducerConfigFields

      socket.connection.setup.timeout.ms

      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.

      Default: 10000 (10 seconds)

      Valid Values:

      Importance: medium

      Specified by:
      socketConnectionSetupTimeoutMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • socketConnectionSetupTimeoutMaxMs

      public ProducerConfigBuilder socketConnectionSetupTimeoutMaxMs(Long value)
      Description copied from interface: ProducerConfigFields

      socket.connection.setup.timeout.max.ms

      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.

      Default: 30000 (30 seconds)

      Valid Values:

      Importance: medium

      Specified by:
      socketConnectionSetupTimeoutMaxMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • connectionsMaxIdleMs

      public ProducerConfigBuilder connectionsMaxIdleMs(Long value)
      Description copied from interface: ProducerConfigFields

      connections.max.idle.ms

      Close idle connections after the number of milliseconds specified by this config.

      Default: 540000 (9 minutes)

      Valid Values:

      Importance: medium

      Specified by:
      connectionsMaxIdleMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • partitionerClass

      public ProducerConfigBuilder partitionerClass(Class value)
      Description copied from interface: ProducerConfigFields

      partitioner.class

      A class to use to determine which partition to be send to when produce the records.
      Available options are:
      • If not set, the default partitioning logic is used.
        This strategy will try sticking to a partition until batch.size bytes is produced to the partition.
        It works with the strategy:
        • If no partition is specified but a key is present, choose a partition based on a hash of the key
        • If no partition or key is present, choose the sticky partition that changes when batch.size bytes are produced to the partition.
      • org.apache.kafka.clients.producer.RoundRobinPartitioner: This partitioning strategy is that each record in a series of consecutive records will be sent to a different partition(no matter if the 'key' is provided or not), until we run out of partitions and start over again.
        Note: There's a known issue that will cause uneven distribution when new batch is created.
        Please check KAFKA-9965 for more detail.

      Implementing the org.apache.kafka.clients.producer.Partitioner interface allows you to plug in a custom partitioner.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      partitionerClass in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • interceptorClasses

      public ProducerConfigBuilder interceptorClasses(List<String> value)
      Description copied from interface: ProducerConfigFields

      interceptor.classes

      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.

      Default: ""

      Valid Values: non-null string

      Importance: low

      Specified by:
      interceptorClasses in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • interceptorClasses

      public ProducerConfigBuilder interceptorClasses(String value)
      Description copied from interface: ProducerConfigFields

      interceptor.classes

      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.

      Default: ""

      Valid Values: non-null string

      Importance: low

      Specified by:
      interceptorClasses in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • securityProtocol

      public ProducerConfigBuilder securityProtocol(String value)
      Description copied from interface: ProducerConfigFields

      security.protocol

      Protocol used to communicate with brokers.
      Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL.

      Default: PLAINTEXT

      Valid Values: [PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL]

      Importance: medium

      Specified by:
      securityProtocol in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • securityProviders

      public ProducerConfigBuilder securityProviders(String value)
      Description copied from interface: ProducerConfigFields

      security.providers

      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.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      securityProviders in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslProtocol

      public ProducerConfigBuilder sslProtocol(String value)
      Description copied from interface: ProducerConfigFields

      ssl.protocol

      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'.

      Default: TLSv1.3

      Valid Values:

      Importance: medium

      Specified by:
      sslProtocol in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslProvider

      public ProducerConfigBuilder sslProvider(String value)
      Description copied from interface: ProducerConfigFields

      ssl.provider

      The name of the security provider used for SSL connections.
      Default value is the default security provider of the JVM.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      sslProvider in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslCipherSuites

      public ProducerConfigBuilder sslCipherSuites(List<String> value)
      Description copied from interface: ProducerConfigFields

      ssl.cipher.suites

      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.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      sslCipherSuites in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslCipherSuites

      public ProducerConfigBuilder sslCipherSuites(String value)
      Description copied from interface: ProducerConfigFields

      ssl.cipher.suites

      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.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      sslCipherSuites in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslEnabledProtocols

      public ProducerConfigBuilder sslEnabledProtocols(List<String> value)
      Description copied from interface: ProducerConfigFields

      ssl.enabled.protocols

      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`.

      Default: TLSv1.2,TLSv1.3

      Valid Values:

      Importance: medium

      Specified by:
      sslEnabledProtocols in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslEnabledProtocols

      public ProducerConfigBuilder sslEnabledProtocols(String value)
      Description copied from interface: ProducerConfigFields

      ssl.enabled.protocols

      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`.

      Default: TLSv1.2,TLSv1.3

      Valid Values:

      Importance: medium

      Specified by:
      sslEnabledProtocols in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeystoreType

      public ProducerConfigBuilder sslKeystoreType(String value)
      Description copied from interface: ProducerConfigFields

      ssl.keystore.type

      The file format of the key store file.
      This is optional for client.
      The values currently supported by the default `ssl.engine.factory.class` are [JKS, PKCS12, PEM].

      Default: JKS

      Valid Values:

      Importance: medium

      Specified by:
      sslKeystoreType in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeystoreLocation

      public ProducerConfigBuilder sslKeystoreLocation(String value)
      Description copied from interface: ProducerConfigFields

      ssl.keystore.location

      The location of the key store file.
      This is optional for client and can be used for two-way authentication for client.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreLocation in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeystorePassword

      public ProducerConfigBuilder sslKeystorePassword(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: ProducerConfigFields

      ssl.keystore.password

      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.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystorePassword in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeystorePassword

      public ProducerConfigBuilder sslKeystorePassword(String value)
      Description copied from interface: ProducerConfigFields

      ssl.keystore.password

      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.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystorePassword in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeyPassword

      public ProducerConfigBuilder sslKeyPassword(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: ProducerConfigFields

      ssl.key.password

      The password of the private key in the key store file or the PEM key specified in `ssl.keystore.key'.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeyPassword in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeyPassword

      public ProducerConfigBuilder sslKeyPassword(String value)
      Description copied from interface: ProducerConfigFields

      ssl.key.password

      The password of the private key in the key store file or the PEM key specified in `ssl.keystore.key'.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeyPassword in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeystoreKey

      public ProducerConfigBuilder sslKeystoreKey(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: ProducerConfigFields

      ssl.keystore.key

      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'

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreKey in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeystoreKey

      public ProducerConfigBuilder sslKeystoreKey(String value)
      Description copied from interface: ProducerConfigFields

      ssl.keystore.key

      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'

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreKey in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeystoreCertificateChain

      public ProducerConfigBuilder sslKeystoreCertificateChain(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: ProducerConfigFields

      ssl.keystore.certificate.chain

      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

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreCertificateChain in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeystoreCertificateChain

      public ProducerConfigBuilder sslKeystoreCertificateChain(String value)
      Description copied from interface: ProducerConfigFields

      ssl.keystore.certificate.chain

      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

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslKeystoreCertificateChain in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslTruststoreCertificates

      public ProducerConfigBuilder sslTruststoreCertificates(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: ProducerConfigFields

      ssl.truststore.certificates

      Trusted certificates in the format specified by 'ssl.truststore.type'.
      Default SSL engine factory supports only PEM format with X.509 certificates.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststoreCertificates in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslTruststoreCertificates

      public ProducerConfigBuilder sslTruststoreCertificates(String value)
      Description copied from interface: ProducerConfigFields

      ssl.truststore.certificates

      Trusted certificates in the format specified by 'ssl.truststore.type'.
      Default SSL engine factory supports only PEM format with X.509 certificates.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststoreCertificates in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslTruststoreType

      public ProducerConfigBuilder sslTruststoreType(String value)
      Description copied from interface: ProducerConfigFields

      ssl.truststore.type

      The file format of the trust store file.
      The values currently supported by the default `ssl.engine.factory.class` are [JKS, PKCS12, PEM].

      Default: JKS

      Valid Values:

      Importance: medium

      Specified by:
      sslTruststoreType in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslTruststoreLocation

      public ProducerConfigBuilder sslTruststoreLocation(String value)
      Description copied from interface: ProducerConfigFields

      ssl.truststore.location

      The location of the trust store file.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststoreLocation in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslTruststorePassword

      public ProducerConfigBuilder sslTruststorePassword(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: ProducerConfigFields

      ssl.truststore.password

      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.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststorePassword in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslTruststorePassword

      public ProducerConfigBuilder sslTruststorePassword(String value)
      Description copied from interface: ProducerConfigFields

      ssl.truststore.password

      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.

      Default: null

      Valid Values:

      Importance: high

      Specified by:
      sslTruststorePassword in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslKeymanagerAlgorithm

      public ProducerConfigBuilder sslKeymanagerAlgorithm(String value)
      Description copied from interface: ProducerConfigFields

      ssl.keymanager.algorithm

      The algorithm used by key manager factory for SSL connections.
      Default value is the key manager factory algorithm configured for the Java Virtual Machine.

      Default: SunX509

      Valid Values:

      Importance: low

      Specified by:
      sslKeymanagerAlgorithm in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslTrustmanagerAlgorithm

      public ProducerConfigBuilder sslTrustmanagerAlgorithm(String value)
      Description copied from interface: ProducerConfigFields

      ssl.trustmanager.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.

      Default: PKIX

      Valid Values:

      Importance: low

      Specified by:
      sslTrustmanagerAlgorithm in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslEndpointIdentificationAlgorithm

      public ProducerConfigBuilder sslEndpointIdentificationAlgorithm(String value)
      Description copied from interface: ProducerConfigFields

      ssl.endpoint.identification.algorithm

      The endpoint identification algorithm to validate server hostname using server certificate.

      Default: https

      Valid Values:

      Importance: low

      Specified by:
      sslEndpointIdentificationAlgorithm in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslSecureRandomImplementation

      public ProducerConfigBuilder sslSecureRandomImplementation(String value)
      Description copied from interface: ProducerConfigFields

      ssl.secure.random.implementation

      The SecureRandom PRNG implementation to use for SSL cryptography operations.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      sslSecureRandomImplementation in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • sslEngineFactoryClass

      public ProducerConfigBuilder sslEngineFactoryClass(Class value)
      Description copied from interface: ProducerConfigFields

      ssl.engine.factory.class

      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

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      sslEngineFactoryClass in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslKerberosServiceName

      public ProducerConfigBuilder saslKerberosServiceName(String value)
      Description copied from interface: ProducerConfigFields

      sasl.kerberos.service.name

      The Kerberos principal name that Kafka runs as.
      This can be defined either in Kafka's JAAS config or in Kafka's config.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslKerberosServiceName in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslKerberosKinitCmd

      public ProducerConfigBuilder saslKerberosKinitCmd(String value)
      Description copied from interface: ProducerConfigFields

      sasl.kerberos.kinit.cmd

      Kerberos kinit command path.

      Default: /usr/bin/kinit

      Valid Values:

      Importance: low

      Specified by:
      saslKerberosKinitCmd in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslKerberosTicketRenewWindowFactor

      public ProducerConfigBuilder saslKerberosTicketRenewWindowFactor(Double value)
      Description copied from interface: ProducerConfigFields

      sasl.kerberos.ticket.renew.window.factor

      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.

      Default: 0.8

      Valid Values:

      Importance: low

      Specified by:
      saslKerberosTicketRenewWindowFactor in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslKerberosTicketRenewJitter

      public ProducerConfigBuilder saslKerberosTicketRenewJitter(Double value)
      Description copied from interface: ProducerConfigFields

      sasl.kerberos.ticket.renew.jitter

      Percentage of random jitter added to the renewal time.

      Default: 0.05

      Valid Values:

      Importance: low

      Specified by:
      saslKerberosTicketRenewJitter in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslKerberosMinTimeBeforeRelogin

      public ProducerConfigBuilder saslKerberosMinTimeBeforeRelogin(Long value)
      Description copied from interface: ProducerConfigFields

      sasl.kerberos.min.time.before.relogin

      Login thread sleep time between refresh attempts.

      Default: 60000

      Valid Values:

      Importance: low

      Specified by:
      saslKerberosMinTimeBeforeRelogin in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginRefreshWindowFactor

      public ProducerConfigBuilder saslLoginRefreshWindowFactor(Double value)
      Description copied from interface: ProducerConfigFields

      sasl.login.refresh.window.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.

      Default: 0.8

      Valid Values: [0.5,...,1.0]

      Importance: low

      Specified by:
      saslLoginRefreshWindowFactor in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginRefreshWindowJitter

      public ProducerConfigBuilder saslLoginRefreshWindowJitter(Double value)
      Description copied from interface: ProducerConfigFields

      sasl.login.refresh.window.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.

      Default: 0.05

      Valid Values: [0.0,...,0.25]

      Importance: low

      Specified by:
      saslLoginRefreshWindowJitter in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginRefreshMinPeriodSeconds

      public ProducerConfigBuilder saslLoginRefreshMinPeriodSeconds(Short value)
      Description copied from interface: ProducerConfigFields

      sasl.login.refresh.min.period.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.

      Default: 60

      Valid Values: [0,...,900]

      Importance: low

      Specified by:
      saslLoginRefreshMinPeriodSeconds in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginRefreshBufferSeconds

      public ProducerConfigBuilder saslLoginRefreshBufferSeconds(Short value)
      Description copied from interface: ProducerConfigFields

      sasl.login.refresh.buffer.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.

      Default: 300

      Valid Values: [0,...,3600]

      Importance: low

      Specified by:
      saslLoginRefreshBufferSeconds in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslMechanism

      public ProducerConfigBuilder saslMechanism(String value)
      Description copied from interface: ProducerConfigFields

      sasl.mechanism

      SASL mechanism used for client connections.
      This may be any mechanism for which a security provider is available.
      GSSAPI is the default mechanism.

      Default: GSSAPI

      Valid Values:

      Importance: medium

      Specified by:
      saslMechanism in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslJaasConfig

      public ProducerConfigBuilder saslJaasConfig(org.apache.kafka.common.config.types.Password value)
      Description copied from interface: ProducerConfigFields

      sasl.jaas.config

      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;

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslJaasConfig in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslJaasConfig

      public ProducerConfigBuilder saslJaasConfig(String value)
      Description copied from interface: ProducerConfigFields

      sasl.jaas.config

      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;

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslJaasConfig in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslClientCallbackHandlerClass

      public ProducerConfigBuilder saslClientCallbackHandlerClass(Class value)
      Description copied from interface: ProducerConfigFields

      sasl.client.callback.handler.class

      The fully qualified name of a SASL client callback handler class that implements the AuthenticateCallbackHandler interface.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslClientCallbackHandlerClass in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginCallbackHandlerClass

      public ProducerConfigBuilder saslLoginCallbackHandlerClass(Class value)
      Description copied from interface: ProducerConfigFields

      sasl.login.callback.handler.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

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslLoginCallbackHandlerClass in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginClass

      public ProducerConfigBuilder saslLoginClass(Class value)
      Description copied from interface: ProducerConfigFields

      sasl.login.class

      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

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslLoginClass in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginConnectTimeoutMs

      public ProducerConfigBuilder saslLoginConnectTimeoutMs(Integer value)
      Description copied from interface: ProducerConfigFields

      sasl.login.connect.timeout.ms

      The (optional) value in milliseconds for the external authentication provider connection timeout.
      Currently applies only to OAUTHBEARER.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslLoginConnectTimeoutMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginReadTimeoutMs

      public ProducerConfigBuilder saslLoginReadTimeoutMs(Integer value)
      Description copied from interface: ProducerConfigFields

      sasl.login.read.timeout.ms

      The (optional) value in milliseconds for the external authentication provider read timeout.
      Currently applies only to OAUTHBEARER.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslLoginReadTimeoutMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginRetryBackoffMaxMs

      public ProducerConfigBuilder saslLoginRetryBackoffMaxMs(Long value)
      Description copied from interface: ProducerConfigFields

      sasl.login.retry.backoff.max.ms

      The (optional) value in milliseconds for the maximum wait between login attempts to the external authentication provider.
      Login uses an exponential backoff algorithm with an initial wait based on the sasl.login.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.login.retry.backoff.max.ms setting.
      Currently applies only to OAUTHBEARER.

      Default: 10000 (10 seconds)

      Valid Values:

      Importance: low

      Specified by:
      saslLoginRetryBackoffMaxMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslLoginRetryBackoffMs

      public ProducerConfigBuilder saslLoginRetryBackoffMs(Long value)
      Description copied from interface: ProducerConfigFields

      sasl.login.retry.backoff.ms

      The (optional) value in milliseconds for the initial wait between login attempts to the external authentication provider.
      Login uses an exponential backoff algorithm with an initial wait based on the sasl.login.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.login.retry.backoff.max.ms setting.
      Currently applies only to OAUTHBEARER.

      Default: 100

      Valid Values:

      Importance: low

      Specified by:
      saslLoginRetryBackoffMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerScopeClaimName

      public ProducerConfigBuilder saslOauthbearerScopeClaimName(String value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.scope.claim.name

      The OAuth claim for the scope is often named "scope", but this (optional) setting can provide a different name to use for the scope included in the JWT payload's claims if the OAuth/OIDC provider uses a different name for that claim.

      Default: scope

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerScopeClaimName in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerSubClaimName

      public ProducerConfigBuilder saslOauthbearerSubClaimName(String value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.sub.claim.name

      The OAuth claim for the subject is often named "sub", but this (optional) setting can provide a different name to use for the subject included in the JWT payload's claims if the OAuth/OIDC provider uses a different name for that claim.

      Default: sub

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerSubClaimName in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerTokenEndpointUrl

      public ProducerConfigBuilder saslOauthbearerTokenEndpointUrl(String value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.token.endpoint.url

      The URL for the OAuth/OIDC identity provider.
      If the URL is HTTP(S)-based, it is the issuer's token endpoint URL to which requests will be made to login based on the configuration in sasl.jaas.config.
      If the URL is file-based, it specifies a file containing an access token (in JWT serialized form) issued by the OAuth/OIDC identity provider to use for authorization.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslOauthbearerTokenEndpointUrl in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerJwksEndpointUrl

      public ProducerConfigBuilder saslOauthbearerJwksEndpointUrl(String value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.jwks.endpoint.url

      The OAuth/OIDC provider URL from which the provider's JWKS (JSON Web Key Set) can be retrieved.
      The URL can be HTTP(S)-based or file-based.
      If the URL is HTTP(S)-based, the JWKS data will be retrieved from the OAuth/OIDC provider via the configured URL on broker startup.
      All then-current keys will be cached on the broker for incoming requests.
      If an authentication request is received for a JWT that includes a "kid" header claim value that isn't yet in the cache, the JWKS endpoint will be queried again on demand.
      However, the broker polls the URL every sasl.oauthbearer.jwks.endpoint.refresh.ms milliseconds to refresh the cache with any forthcoming keys before any JWT requests that include them are received.
      If the URL is file-based, the broker will load the JWKS file from a configured location on startup.
      In the event that the JWT includes a "kid" header value that isn't in the JWKS file, the broker will reject the JWT and authentication will fail.

      Default: null

      Valid Values:

      Importance: medium

      Specified by:
      saslOauthbearerJwksEndpointUrl in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerJwksEndpointRefreshMs

      public ProducerConfigBuilder saslOauthbearerJwksEndpointRefreshMs(Long value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.jwks.endpoint.refresh.ms

      The (optional) value in milliseconds for the broker to wait between refreshing its JWKS (JSON Web Key Set) cache that contains the keys to verify the signature of the JWT.

      Default: 3600000 (1 hour)

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerJwksEndpointRefreshMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerJwksEndpointRetryBackoffMaxMs

      public ProducerConfigBuilder saslOauthbearerJwksEndpointRetryBackoffMaxMs(Long value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms

      The (optional) value in milliseconds for the maximum wait between attempts to retrieve the JWKS (JSON Web Key Set) from the external authentication provider.
      JWKS retrieval uses an exponential backoff algorithm with an initial wait based on the sasl.oauthbearer.jwks.endpoint.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms setting.

      Default: 10000 (10 seconds)

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerJwksEndpointRetryBackoffMaxMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerJwksEndpointRetryBackoffMs

      public ProducerConfigBuilder saslOauthbearerJwksEndpointRetryBackoffMs(Long value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.jwks.endpoint.retry.backoff.ms

      The (optional) value in milliseconds for the initial wait between JWKS (JSON Web Key Set) retrieval attempts from the external authentication provider.
      JWKS retrieval uses an exponential backoff algorithm with an initial wait based on the sasl.oauthbearer.jwks.endpoint.retry.backoff.ms setting and will double in wait length between attempts up to a maximum wait length specified by the sasl.oauthbearer.jwks.endpoint.retry.backoff.max.ms setting.

      Default: 100

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerJwksEndpointRetryBackoffMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerClockSkewSeconds

      public ProducerConfigBuilder saslOauthbearerClockSkewSeconds(Integer value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.clock.skew.seconds

      The (optional) value in seconds to allow for differences between the time of the OAuth/OIDC identity provider and the broker.

      Default: 30

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerClockSkewSeconds in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerExpectedAudience

      public ProducerConfigBuilder saslOauthbearerExpectedAudience(List<String> value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.expected.audience

      The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences.
      The JWT will be inspected for the standard OAuth "aud" claim and if this value is set, the broker will match the value from JWT's "aud" claim to see if there is an exact match.
      If there is no match, the broker will reject the JWT and authentication will fail.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerExpectedAudience in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerExpectedAudience

      public ProducerConfigBuilder saslOauthbearerExpectedAudience(String value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.expected.audience

      The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences.
      The JWT will be inspected for the standard OAuth "aud" claim and if this value is set, the broker will match the value from JWT's "aud" claim to see if there is an exact match.
      If there is no match, the broker will reject the JWT and authentication will fail.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerExpectedAudience in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • saslOauthbearerExpectedIssuer

      public ProducerConfigBuilder saslOauthbearerExpectedIssuer(String value)
      Description copied from interface: ProducerConfigFields

      sasl.oauthbearer.expected.issuer

      The (optional) setting for the broker to use to verify that the JWT was created by the expected issuer.
      The JWT will be inspected for the standard OAuth "iss" claim and if this value is set, the broker will match it exactly against what is in the JWT's "iss" claim.
      If there is no match, the broker will reject the JWT and authentication will fail.

      Default: null

      Valid Values:

      Importance: low

      Specified by:
      saslOauthbearerExpectedIssuer in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • enableIdempotence

      public ProducerConfigBuilder enableIdempotence(Boolean value)
      Description copied from interface: ProducerConfigFields

      enable.idempotence

      When set to 'true', the producer will ensure that exactly one copy of each message is written in the stream.
      If 'false', producer retries due to broker failures, etc., may write duplicates of the retried message in the stream.
      Note that enabling idempotence requires max.in.flight.requests.per.connection to be less than or equal to 5 (with message ordering preserved for any allowable value), retries to be greater than 0, and acks must be 'all'.

      Idempotence is enabled by default if no conflicting configurations are set.
      If conflicting configurations are set and idempotence is not explicitly enabled, idempotence is disabled.
      If idempotence is explicitly enabled and conflicting configurations are set, a ConfigException is thrown.

      Default: true

      Valid Values:

      Importance: low

      Specified by:
      enableIdempotence in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • transactionTimeoutMs

      public ProducerConfigBuilder transactionTimeoutMs(Integer value)
      Description copied from interface: ProducerConfigFields

      transaction.timeout.ms

      The maximum amount of time in ms that the transaction coordinator will wait for a transaction status update from the producer before proactively aborting the ongoing transaction.If this value is larger than the transaction.max.timeout.ms setting in the broker, the request will fail with a InvalidTxnTimeoutException error.

      Default: 60000 (1 minute)

      Valid Values:

      Importance: low

      Specified by:
      transactionTimeoutMs in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>

    • transactionalId

      public ProducerConfigBuilder transactionalId(String value)
      Description copied from interface: ProducerConfigFields

      transactional.id

      The TransactionalId to use for transactional delivery.
      This enables reliability semantics which span multiple producer sessions since it allows the client to guarantee that transactions using the same TransactionalId have been completed prior to starting any new transactions.
      If no TransactionalId is provided, then the producer is limited to idempotent delivery.
      If a TransactionalId is configured, enable.idempotence is implied.
      By default the TransactionId is not configured, which means transactions cannot be used.
      Note that, by default, transactions require a cluster of at least three brokers which is the recommended setting for production; for development you can change this, by adjusting broker setting transaction.state.log.replication.factor.

      Default: null

      Valid Values: non-empty string

      Importance: low

      Specified by:
      transactionalId in interface ProducerConfigFields<T extends org.swisspush.kobuka.client.base.AbstractProducerConfigBuilder<T>>