StreamsConfigBuilder (kafka-config 2.7.0 API)

java.lang.Object
- net.soundvibe.kafka.config.AbstractConfigBuilder<StreamsConfigBuilder>
- - net.soundvibe.kafka.config.streams.StreamsConfigBuilder

All Implemented Interfaces:: ConfigBuilder

public final class StreamsConfigBuilder
extends AbstractConfigBuilder<StreamsConfigBuilder>

Field Summary
- Fields inherited from class net.soundvibe.kafka.config.AbstractConfigBuilder
  props

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static StreamsConfigBuilder`	`create()`
`StreamsConfigBuilder`	`withAcceptableRecoveryLag(long acceptableRecoveryLag)` The maximum acceptable lag (number of offsets to catch up) for a client to be considered caught-up for an active task.
`StreamsConfigBuilder`	`withApplicationId(String applicationId)` An identifier for the stream processing application.
`StreamsConfigBuilder`	`withApplicationServer(String applicationServer)` A host:port pair pointing to an embedded user defined endpoint that can be used for discovering the locations of state stores within a single KafkaStreams application
`StreamsConfigBuilder`	`withBufferedRecordsPerPartition(int bufferedRecordsPerPartition)` Maximum number of records to buffer per partition.
`StreamsConfigBuilder`	`withCacheMaxBytesBuffering(long cacheMaxBytesBuffering)` Maximum number of memory bytes to be used for buffering across all threads
`StreamsConfigBuilder`	`withClientId(String clientId)` An ID prefix string used for the client IDs of internal consumer, producer and restore-consumer, with pattern '-StreamThread--'
`StreamsConfigBuilder`	`withCommitInterval(Duration commitInterval)` The frequency with which to save the position of the processor.
`StreamsConfigBuilder`	`withDefaultDeserializationExceptionHandler(Class<? extends org.apache.kafka.streams.errors.DeserializationExceptionHandler> defaultDeserializationExceptionHandler)` Exception handling class that implements the `org.apache.kafka.streams.errors.DeserializationExceptionHandler` interface.
`StreamsConfigBuilder`	`withDefaultKeySerde(Class<? extends org.apache.kafka.common.serialization.Serde<?>> defaultKeySerde)` Default serializer / deserializer class for key that implements the `org.apache.kafka.common.serialization.Serde` interface.
`StreamsConfigBuilder`	`withDefaultProductionExceptionHandler(Class<? extends org.apache.kafka.streams.errors.ProductionExceptionHandler> defaultProductionExceptionHandler)` Exception handling class that implements the `org.apache.kafka.streams.errors.ProductionExceptionHandler` interface.
`StreamsConfigBuilder`	`withDefaultTimestampExtractor(Class<? extends org.apache.kafka.streams.processor.TimestampExtractor> defaultTimestampExtractor)` Default timestamp extractor class that implements the `org.apache.kafka.streams.processor.TimestampExtractor` interface.
`StreamsConfigBuilder`	`withDefaultValueSerde(Class<? extends org.apache.kafka.common.serialization.Serde<?>> defaultValueSerde)` Default serializer / deserializer class for value that implements the `org.apache.kafka.common.serialization.Serde` interface.
`StreamsConfigBuilder`	`withMaxTaskIdle(Duration maxTaskIdle)` Maximum amount of time a stream task will stay idle when not all of its partition buffers contain records, to avoid potential out-of-order record processing across multiple input streams.
`StreamsConfigBuilder`	`withMaxWarmupReplicas(int maxWarmupReplicas)` 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.
`StreamsConfigBuilder`	`withNumStandbyReplicas(int numStandbyReplicas)` The number of standby replicas for each task.
`StreamsConfigBuilder`	`withNumStreamThreads(int numStreamThreads)` The number of threads to execute stream processing.
`StreamsConfigBuilder`	`withPartitionGrouper(Class<? extends org.apache.kafka.streams.processor.PartitionGrouper> partitionGrouper)` Deprecated.
`StreamsConfigBuilder`	`withPoll(Duration poll)` The amount of time to block waiting for input.
`StreamsConfigBuilder`	`withProbingRebalanceInterval(Duration probingRebalanceInterval)` The maximum time to wait before triggering a rebalance to probe for warmup replicas that have finished warming up and are ready to become active.
`StreamsConfigBuilder`	`withProcessingGuarantee(ProcessingGuarantee processingGuarantee)` The processing guarantee that should be used.
`StreamsConfigBuilder`	`withReplicationFactor(int replicationFactor)` The replication factor for change log topics and repartition topics created by the stream processing application.
`StreamsConfigBuilder`	`withRocksDBConfigSetter(Class<? extends org.apache.kafka.streams.state.RocksDBConfigSetter> rocksDBConfigSetter)` A Rocks DB config setter class or class name that implements the `org.apache.kafka.streams.state.RocksDBConfigSetter` interface
`StreamsConfigBuilder`	`withStateCleanupDelay(Duration stateCleanupDelay)` The amount of time in milliseconds to wait before deleting state when a partition has migrated.
`StreamsConfigBuilder`	`withStateDir(Path stateDir)` The replication factor for change log topics and repartition topics created by the stream processing application.
`StreamsConfigBuilder`	`withTopologyOptimization(TopologyOptimization topologyOptimization)` A configuration telling Kafka Streams if it should optimize the topology, disabled by default
`StreamsConfigBuilder`	`withUpgradeFrom(UpgradeFrom upgradeFrom)` Allows upgrading from versions 0.10.0/0.10.1/0.10.2/0.11.0/1.0/1.1 to version 1.2 (or newer) in a backward compatible way.
`StreamsConfigBuilder`	`withWindowStoreChangeLogAdditionalRetention(Duration windowStoreChangeLogAdditionalRetention)` Added to a windows maintainMs to ensure data is not deleted from the log prematurely.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static StreamsConfigBuilder create()
```
  - withApplicationId
```
public StreamsConfigBuilder withApplicationId(String applicationId)
```
    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.
  - withReplicationFactor
```
public StreamsConfigBuilder withReplicationFactor(int replicationFactor)
```
    The replication factor for change log topics and repartition topics created by the stream processing application.
  - withStateDir
```
public StreamsConfigBuilder withStateDir(Path stateDir)
```
    The replication factor for change log topics and repartition topics created by the stream processing application.
  - withCacheMaxBytesBuffering
```
public StreamsConfigBuilder withCacheMaxBytesBuffering(long cacheMaxBytesBuffering)
```
    Maximum number of memory bytes to be used for buffering across all threads
  - withClientId
```
public StreamsConfigBuilder withClientId(String clientId)
```
    An ID prefix string used for the client IDs of internal consumer, producer and restore-consumer, with pattern '-StreamThread--'
    
    Overrides:
    
    withClientId in class AbstractConfigBuilder<StreamsConfigBuilder>
  - withDefaultDeserializationExceptionHandler
```
public StreamsConfigBuilder withDefaultDeserializationExceptionHandler(Class<? extends org.apache.kafka.streams.errors.DeserializationExceptionHandler> defaultDeserializationExceptionHandler)
```
    Exception handling class that implements the org.apache.kafka.streams.errors.DeserializationExceptionHandler interface.
  - withDefaultKeySerde
```
public StreamsConfigBuilder withDefaultKeySerde(Class<? extends org.apache.kafka.common.serialization.Serde<?>> defaultKeySerde)
```
    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_CLASS or DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS as well
  - withDefaultValueSerde
```
public StreamsConfigBuilder withDefaultValueSerde(Class<? extends org.apache.kafka.common.serialization.Serde<?>> defaultValueSerde)
```
    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_CLASS or DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS as well
  - withDefaultProductionExceptionHandler
```
public StreamsConfigBuilder withDefaultProductionExceptionHandler(Class<? extends org.apache.kafka.streams.errors.ProductionExceptionHandler> defaultProductionExceptionHandler)
```
    Exception handling class that implements the org.apache.kafka.streams.errors.ProductionExceptionHandler interface.
  - withDefaultTimestampExtractor
```
public StreamsConfigBuilder withDefaultTimestampExtractor(Class<? extends org.apache.kafka.streams.processor.TimestampExtractor> defaultTimestampExtractor)
```
    Default timestamp extractor class that implements the org.apache.kafka.streams.processor.TimestampExtractor interface.
  - withNumStandbyReplicas
```
public StreamsConfigBuilder withNumStandbyReplicas(int numStandbyReplicas)
```
    The number of standby replicas for each task.
  - withNumStreamThreads
```
public StreamsConfigBuilder withNumStreamThreads(int numStreamThreads)
```
    The number of threads to execute stream processing.
  - withMaxTaskIdle
```
public StreamsConfigBuilder withMaxTaskIdle(Duration maxTaskIdle)
```
    Maximum amount of time a stream task will stay idle when not all of its partition buffers contain records, to avoid potential out-of-order record processing across multiple input streams.
  - withProcessingGuarantee
```
public StreamsConfigBuilder withProcessingGuarantee(ProcessingGuarantee processingGuarantee)
```
    The processing guarantee that should be used. Possible values are AT_LEAST_ONCE (default) and EXACTLY_ONCE. 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.
  - withTopologyOptimization
```
public StreamsConfigBuilder withTopologyOptimization(TopologyOptimization topologyOptimization)
```
    A configuration telling Kafka Streams if it should optimize the topology, disabled by default
  - withApplicationServer
```
public StreamsConfigBuilder withApplicationServer(String applicationServer)
```
    A host:port pair pointing to an embedded user defined endpoint that can be used for discovering the locations of state stores within a single KafkaStreams application
  - withBufferedRecordsPerPartition
```
public StreamsConfigBuilder withBufferedRecordsPerPartition(int bufferedRecordsPerPartition)
```
    Maximum number of records to buffer per partition.
  - withCommitInterval
```
public StreamsConfigBuilder withCommitInterval(Duration commitInterval)
```
    The frequency with which to save the position of the processor. (Note, if processing.guarantee is set to EXACTLY_ONCE, the default value is EOS_DEFAULT_COMMIT_INTERVAL_MS, otherwise the default value is DEFAULT_COMMIT_INTERVAL_MS".
  - withPartitionGrouper
```
@Deprecated
public StreamsConfigBuilder withPartitionGrouper(Class<? extends org.apache.kafka.streams.processor.PartitionGrouper> partitionGrouper)
```
    Deprecated.
    
    Partition grouper class that implements the org.apache.kafka.streams.processor.PartitionGrouper interface." WARNING: This config is deprecated and will be removed in 3.0.0 release.
  - withPoll
```
public StreamsConfigBuilder withPoll(Duration poll)
```
    The amount of time to block waiting for input.
  - withRocksDBConfigSetter
```
public StreamsConfigBuilder withRocksDBConfigSetter(Class<? extends org.apache.kafka.streams.state.RocksDBConfigSetter> rocksDBConfigSetter)
```
    A Rocks DB config setter class or class name that implements the org.apache.kafka.streams.state.RocksDBConfigSetter interface
  - withStateCleanupDelay
```
public StreamsConfigBuilder withStateCleanupDelay(Duration stateCleanupDelay)
```
    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
  - withUpgradeFrom
```
public StreamsConfigBuilder withUpgradeFrom(UpgradeFrom upgradeFrom)
```
    Allows upgrading from versions 0.10.0/0.10.1/0.10.2/0.11.0/1.0/1.1 to version 1.2 (or newer) in a backward compatible way. When upgrading from 1.2 to a newer version it is not required to specify this config." + Default is null. Accepted values are UPGRADE_FROM_0100, UPGRADE_FROM_0101, UPGRADE_FROM_0102, UPGRADE_FROM_0110, UPGRADE_FROM_10, UPGRADE_FROM_11(for upgrading from the corresponding old version).
  - withWindowStoreChangeLogAdditionalRetention
```
public StreamsConfigBuilder withWindowStoreChangeLogAdditionalRetention(Duration windowStoreChangeLogAdditionalRetention)
```
    Added to a windows maintainMs to ensure data is not deleted from the log prematurely. Allows for clock drift. Default is 1 day
  - withAcceptableRecoveryLag
```
public StreamsConfigBuilder withAcceptableRecoveryLag(long acceptableRecoveryLag)
```
    The maximum acceptable lag (number of offsets to catch up) for a client to be considered caught-up for an active task. Should correspond to a recovery time of well under a minute for a given workload. Must be at least 0.
  - withMaxWarmupReplicas
```
public StreamsConfigBuilder withMaxWarmupReplicas(int maxWarmupReplicas)
```
    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.
  - withProbingRebalanceInterval
```
public StreamsConfigBuilder withProbingRebalanceInterval(Duration probingRebalanceInterval)
```
    The maximum time 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.

Class StreamsConfigBuilder

Field Summary

Fields inherited from class net.soundvibe.kafka.config.AbstractConfigBuilder

Method Summary

Methods inherited from class net.soundvibe.kafka.config.AbstractConfigBuilder

Methods inherited from class java.lang.Object

Method Detail

create

withApplicationId

withReplicationFactor

withStateDir

withCacheMaxBytesBuffering

withClientId

withDefaultDeserializationExceptionHandler

withDefaultKeySerde

withDefaultValueSerde

withDefaultProductionExceptionHandler

withDefaultTimestampExtractor

withNumStandbyReplicas

withNumStreamThreads

withMaxTaskIdle

withProcessingGuarantee

withTopologyOptimization

withApplicationServer

withBufferedRecordsPerPartition

withCommitInterval

withPartitionGrouper

withPoll

withRocksDBConfigSetter

withStateCleanupDelay

withUpgradeFrom

withWindowStoreChangeLogAdditionalRetention

withAcceptableRecoveryLag

withMaxWarmupReplicas

withProbingRebalanceInterval