Package org.swisspush.kobuka.client.base

Interface StreamsConfigFields<T extends StreamsConfigFields<T>>

All Known Implementing Classes:
BaseStreamsConfigBuilder, StreamsConfigBuilder
public interface StreamsConfigFields<T extends StreamsConfigFields<T>>

  • Method Details

    • applicationId

      T applicationId(String value)

      application.id

      An identifier for the stream processing application.
      Must be unique within the Kafka cluster.
      It is used as 1) the default client-id prefix, 2) the group-id for membership management, 3) the changelog topic prefix.

      Default:

      Valid Values:

      Importance: high

    • bootstrapServers

      T bootstrapServers(List<String> value)

      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:

      Importance: high

    • bootstrapServers

      T bootstrapServers(String value)

      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:

      Importance: high

    • numStandbyReplicas

      T numStandbyReplicas(Integer value)

      num.standby.replicas

      The number of standby replicas for each task.

      Default: 0

      Valid Values:

      Importance: high

    • stateDir

      T stateDir(String value)

      state.dir

      Directory location for state store.
      This path must be unique for each streams instance sharing the same underlying filesystem.

      Default: /tmp/kafka-streams

      Valid Values:

      Importance: high

    • acceptableRecoveryLag

      T acceptableRecoveryLag(Long value)

      acceptable.recovery.lag

      The maximum acceptable lag (number of offsets to catch up) for a client to be considered caught-up enough to receive an active task assignment.
      Upon assignment, it will still restore the rest of the changelog before processing.
      To avoid a pause in processing during rebalances, this config should correspond to a recovery time of well under a minute for a given workload.
      Must be at least 0.

      Default: 10000

      Valid Values: [0,...]

      Importance: medium

    • cacheMaxBytesBuffering

      T cacheMaxBytesBuffering(Long value)

      cache.max.bytes.buffering

      Maximum number of memory bytes to be used for buffering across all threads

      Default: 10485760

      Valid Values: [0,...]

      Importance: medium

    • clientId

      T clientId(String value)

      client.id

      An ID prefix string used for the client IDs of internal consumer, producer and restore-consumer, with pattern '<client.id>-StreamThread--<consumer|producer|restore-consumer>'.

      Default: ""

      Valid Values:

      Importance: medium

    • defaultDeserializationExceptionHandler

      T defaultDeserializationExceptionHandler(Class value)

      default.deserialization.exception.handler

      Exception handling class that implements the org.apache.kafka.streams.errors.DeserializationExceptionHandler interface.

      Default: org.apache.kafka.streams.errors.LogAndFailExceptionHandler

      Valid Values:

      Importance: medium

    • defaultKeySerde

      T defaultKeySerde(Class value)

      default.key.serde

      Default serializer / deserializer class for key that implements the org.apache.kafka.common.serialization.Serde interface.
      Note when windowed serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.windowed.key.serde.inner' or 'default.windowed.value.serde.inner' as well

      Default: null

      Valid Values:

      Importance: medium

    • defaultListKeySerdeInner

      T defaultListKeySerdeInner(Class value)

      default.list.key.serde.inner

      Default inner class of list serde for key that implements the org.apache.kafka.common.serialization.Serde interface.
      This configuration will be read if and only if default.key.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde

      Default: null

      Valid Values:

      Importance: medium

    • defaultListValueSerdeInner

      T defaultListValueSerdeInner(Class value)

      default.list.value.serde.inner

      Default inner class of list serde for value that implements the org.apache.kafka.common.serialization.Serde interface.
      This configuration will be read if and only if default.value.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde

      Default: null

      Valid Values:

      Importance: medium

    • defaultListKeySerdeType

      T defaultListKeySerdeType(Class value)

      default.list.key.serde.type

      Default class for key that implements the java.util.List interface.
      This configuration will be read if and only if default.key.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde Note when list serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.list.key.serde.inner'

      Default: null

      Valid Values:

      Importance: medium

    • defaultListValueSerdeType

      T defaultListValueSerdeType(Class value)

      default.list.value.serde.type

      Default class for value that implements the java.util.List interface.
      This configuration will be read if and only if default.value.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde Note when list serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.list.value.serde.inner'

      Default: null

      Valid Values:

      Importance: medium

    • defaultProductionExceptionHandler

      T defaultProductionExceptionHandler(Class value)

      default.production.exception.handler

      Exception handling class that implements the org.apache.kafka.streams.errors.ProductionExceptionHandler interface.

      Default: org.apache.kafka.streams.errors.DefaultProductionExceptionHandler

      Valid Values:

      Importance: medium

    • defaultTimestampExtractor

      T defaultTimestampExtractor(Class value)

      default.timestamp.extractor

      Default timestamp extractor class that implements the org.apache.kafka.streams.processor.TimestampExtractor interface.

      Default: org.apache.kafka.streams.processor.FailOnInvalidTimestamp

      Valid Values:

      Importance: medium

    • defaultValueSerde

      T defaultValueSerde(Class value)

      default.value.serde

      Default serializer / deserializer class for value that implements the org.apache.kafka.common.serialization.Serde interface.
      Note when windowed serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.windowed.key.serde.inner' or 'default.windowed.value.serde.inner' as well

      Default: null

      Valid Values:

      Importance: medium

    • maxTaskIdleMs

      T maxTaskIdleMs(Long value)

      max.task.idle.ms

      This config controls whether joins and merges may produce out-of-order results.
      The config value is the maximum amount of time in milliseconds a stream task will stay idle when it is fully caught up on some (but not all) input partitions to wait for producers to send additional records and avoid potential out-of-order record processing across multiple input streams.
      The default (zero) does not wait for producers to send more records, but it does wait to fetch data that is already present on the brokers.
      This default means that for records that are already present on the brokers, Streams will process them in timestamp order.
      Set to -1 to disable idling entirely and process any locally available data, even though doing so may produce out-of-order processing.

      Default: 0

      Valid Values:

      Importance: medium

    • maxWarmupReplicas

      T maxWarmupReplicas(Integer value)

      max.warmup.replicas

      The maximum number of warmup replicas (extra standbys beyond the configured num.standbys) that can be assigned at once for the purpose of keeping the task available on one instance while it is warming up on another instance it has been reassigned to.
      Used to throttle how much extra broker traffic and cluster state can be used for high availability.
      Must be at least 1.

      Default: 2

      Valid Values: [1,...]

      Importance: medium

    • numStreamThreads

      T numStreamThreads(Integer value)

      num.stream.threads

      The number of threads to execute stream processing.

      Default: 1

      Valid Values:

      Importance: medium

    • processingGuarantee

      T processingGuarantee(String value)

      processing.guarantee

      The processing guarantee that should be used.
      Possible values are at_least_once (default) and exactly_once_v2 (requires brokers version 2.5 or higher).
      Deprecated options are exactly_once (requires brokers version 0.11.0 or higher) and exactly_once_beta (requires brokers version 2.5 or higher).
      Note that exactly-once processing requires a cluster of at least three brokers by default what is the recommended setting for production; for development you can change this, by adjusting broker setting transaction.state.log.replication.factor and transaction.state.log.min.isr.

      Default: at_least_once

      Valid Values: [at_least_once, exactly_once, exactly_once_beta, exactly_once_v2]

      Importance: medium

    • rackAwareAssignmentTags

      T rackAwareAssignmentTags(List<String> value)

      rack.aware.assignment.tags

      List of client tag keys used to distribute standby replicas across Kafka Streams instances.
      When configured, Kafka Streams will make a best-effort to distribute the standby tasks over each client tag dimension.

      Default: ""

      Valid Values: List containing maximum of 5 elements

      Importance: medium

    • rackAwareAssignmentTags

      T rackAwareAssignmentTags(String value)

      rack.aware.assignment.tags

      List of client tag keys used to distribute standby replicas across Kafka Streams instances.
      When configured, Kafka Streams will make a best-effort to distribute the standby tasks over each client tag dimension.

      Default: ""

      Valid Values: List containing maximum of 5 elements

      Importance: medium

    • replicationFactor

      T replicationFactor(Integer value)

      replication.factor

      The replication factor for change log topics and repartition topics created by the stream processing application.
      The default of -1 (meaning: use broker default replication factor) requires broker version 2.4 or newer

      Default: -1

      Valid Values:

      Importance: medium

    • securityProtocol

      T securityProtocol(String value)

      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

    • taskTimeoutMs

      T taskTimeoutMs(Long value)

      task.timeout.ms

      The maximum amount of time in milliseconds a task might stall due to internal errors and retries until an error is raised.
      For a timeout of 0ms, a task would raise an error for the first internal error.
      For any timeout larger than 0ms, a task will retry at least once before an error is raised.

      Default: 300000 (5 minutes)

      Valid Values: [0,...]

      Importance: medium

    • topologyOptimization

      T topologyOptimization(String value)

      topology.optimization

      A configuration telling Kafka Streams if it should optimize the topology, disabled by default

      Default: none

      Valid Values: [none, all]

      Importance: medium

    • applicationServer

      T applicationServer(String value)

      application.server

      A host:port pair pointing to a user-defined endpoint that can be used for state store discovery and interactive queries on this KafkaStreams instance.

      Default: ""

      Valid Values:

      Importance: low

    • bufferedRecordsPerPartition

      T bufferedRecordsPerPartition(Integer value)

      buffered.records.per.partition

      Maximum number of records to buffer per partition.

      Default: 1000

      Valid Values:

      Importance: low

    • builtInMetricsVersion

      T builtInMetricsVersion(String value)

      built.in.metrics.version

      Version of the built-in metrics to use.

      Default: latest

      Valid Values: [latest]

      Importance: low

    • commitIntervalMs

      T commitIntervalMs(Long value)

      commit.interval.ms

      The frequency in milliseconds with which to commit processing progress.
      For at-least-once processing, committing means to save the position (ie, offsets) of the processor.
      For exactly-once processing, it means to commit the transaction which includes to save the position and to make the committed data in the output topic visible to consumers with isolation level read_committed.
      (Note, if processing.guarantee is set to exactly_once_v2, exactly_once,the default value is 100, otherwise the default value is 30000.

      Default: 30000 (30 seconds)

      Valid Values: [0,...]

      Importance: low

    • repartitionPurgeIntervalMs

      T repartitionPurgeIntervalMs(Long value)

      repartition.purge.interval.ms

      The frequency in milliseconds with which to delete fully consumed records from repartition topics.
      Purging will occur after at least this value since the last purge, but may be delayed until later.
      (Note, unlike commit.interval.ms, the default for this value remains unchanged when processing.guarantee is set to exactly_once_v2).

      Default: 30000 (30 seconds)

      Valid Values: [0,...]

      Importance: low

    • connectionsMaxIdleMs

      T connectionsMaxIdleMs(Long value)

      connections.max.idle.ms

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

      Default: 540000 (9 minutes)

      Valid Values:

      Importance: low

    • defaultDslStore

      T defaultDslStore(String value)

      default.dsl.store

      The default state store type used by DSL operators.

      Default: rocksDB

      Valid Values: [rocksDB, in_memory]

      Importance: low

    • metadataMaxAgeMs

      T metadataMaxAgeMs(Long value)

      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

    • metricsNumSamples

      T metricsNumSamples(Integer value)

      metrics.num.samples

      The number of samples maintained to compute metrics.

      Default: 2

      Valid Values: [1,...]

      Importance: low

    • metricReporters

      T metricReporters(List<String> value)

      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:

      Importance: low

    • metricReporters

      T metricReporters(String value)

      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:

      Importance: low

    • metricsRecordingLevel

      T metricsRecordingLevel(String value)

      metrics.recording.level

      The highest recording level for metrics.

      Default: INFO

      Valid Values: [INFO, DEBUG, TRACE]

      Importance: low

    • metricsSampleWindowMs

      T metricsSampleWindowMs(Long value)

      metrics.sample.window.ms

      The window of time a metrics sample is computed over.

      Default: 30000 (30 seconds)

      Valid Values: [0,...]

      Importance: low

    • pollMs

      T pollMs(Long value)

      poll.ms

      The amount of time in milliseconds to block waiting for input.

      Default: 100

      Valid Values:

      Importance: low

    • probingRebalanceIntervalMs

      T probingRebalanceIntervalMs(Long value)

      probing.rebalance.interval.ms

      The maximum time in milliseconds to wait before triggering a rebalance to probe for warmup replicas that have finished warming up and are ready to become active.
      Probing rebalances will continue to be triggered until the assignment is balanced.
      Must be at least 1 minute.

      Default: 600000 (10 minutes)

      Valid Values: [60000,...]

      Importance: low

    • receiveBufferBytes

      T receiveBufferBytes(Integer value)

      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: low

    • reconnectBackoffMs

      T reconnectBackoffMs(Long value)

      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

    • reconnectBackoffMaxMs

      T reconnectBackoffMaxMs(Long value)

      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

    • retries

      T retries(Integer value)

      retries

      Setting a value greater than zero will cause the client to resend any request that fails with a potentially transient error.
      It is recommended to set the value to either zero or `MAX_VALUE` and use corresponding timeout parameters to control how long a client should retry a request.

      Default: 0

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

      Importance: low

    • retryBackoffMs

      T retryBackoffMs(Long value)

      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

    • requestTimeoutMs

      T requestTimeoutMs(Integer value)

      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.

      Default: 40000 (40 seconds)

      Valid Values: [0,...]

      Importance: low

    • rocksdbConfigSetter

      T rocksdbConfigSetter(Class value)

      rocksdb.config.setter

      A Rocks DB config setter class or class name that implements the org.apache.kafka.streams.state.RocksDBConfigSetter interface

      Default: null

      Valid Values:

      Importance: low

    • sendBufferBytes

      T sendBufferBytes(Integer value)

      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: low

    • stateCleanupDelayMs

      T stateCleanupDelayMs(Long value)

      state.cleanup.delay.ms

      The amount of time in milliseconds to wait before deleting state when a partition has migrated.
      Only state directories that have not been modified for at least state.cleanup.delay.ms will be removed

      Default: 600000 (10 minutes)

      Valid Values:

      Importance: low

    • upgradeFrom

      T upgradeFrom(String value)

      upgrade.from

      Allows upgrading in a backward compatible way.
      This is needed when upgrading from [0.10.0, 1.1] to 2.0+, or when upgrading from [2.0, 2.3] to 2.4+.
      When upgrading from 3.3 to a newer version it is not required to specify this config.
      Default is `null`.
      Accepted values are "0.10.0", "0.10.1", "0.10.2", "0.11.0", "1.0", "1.1", "2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "2.8", "3.0", "3.1", "3.2" (for upgrading from the corresponding old version).

      Default: null

      Valid Values: [null, 0.10.0, 0.10.1, 0.10.2, 0.11.0, 1.0, 1.1, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 3.0, 3.1, 3.2]

      Importance: low

    • windowedInnerClassSerde

      T windowedInnerClassSerde(String value)

      windowed.inner.class.serde

      Default serializer / deserializer for the inner class of a windowed record.
      Must implement the org.apache.kafka.common.serialization.Serde interface.
      Note that setting this config in KafkaStreams application would result in an error as it is meant to be used only from Plain consumer client.

      Default: null

      Valid Values:

      Importance: low

    • windowstoreChangelogAdditionalRetentionMs

      T windowstoreChangelogAdditionalRetentionMs(Long value)

      windowstore.changelog.additional.retention.ms

      Added to a windows maintainMs to ensure data is not deleted from the log prematurely.
      Allows for clock drift.
      Default is 1 day

      Default: 86400000 (1 day)

      Valid Values:

      Importance: low

    • windowSizeMs

      T windowSizeMs(Long value)

      window.size.ms

      Sets window size for the deserializer in order to calculate window end times.

      Default: null

      Valid Values:

      Importance: low

    • self

      default T self()