StreamsConfig (kafka 2.4.1 API)

java.lang.Object
- org.apache.kafka.common.config.AbstractConfig
- - org.apache.kafka.streams.StreamsConfig

```
public class StreamsConfig
extends AbstractConfig
```
Configuration for a KafkaStreams instance. Can also be used to configure the Kafka Streams internal KafkaConsumer, KafkaProducer and Admin. To avoid consumer/producer/admin property conflicts, you should prefix those properties using consumerPrefix(String), producerPrefix(String) and adminClientPrefix(String), respectively.
Example:
```
 // potentially wrong: sets "metadata.max.age.ms" to 1 minute for producer AND consumer
 Properties streamsProperties = new Properties();
 streamsProperties.put(ConsumerConfig.METADATA_MAX_AGE_CONFIG, 60000);
 // or
 streamsProperties.put(ProducerConfig.METADATA_MAX_AGE_CONFIG, 60000);

 // suggested:
 Properties streamsProperties = new Properties();
 // sets "metadata.max.age.ms" to 1 minute for consumer only
 streamsProperties.put(StreamsConfig.consumerPrefix(ConsumerConfig.METADATA_MAX_AGE_CONFIG), 60000);
 // sets "metadata.max.age.ms" to 1 minute for producer only
 streamsProperties.put(StreamsConfig.producerPrefix(ProducerConfig.METADATA_MAX_AGE_CONFIG), 60000);

 StreamsConfig streamsConfig = new StreamsConfig(streamsProperties);
 
```
This instance can also be used to pass in custom configurations to different modules (e.g. passing a special config in your customized serde class). The consumer/producer/admin prefix can also be used to distinguish these custom config values passed to different clients with the same config name. * Example:
```
 Properties streamsProperties = new Properties();
 // sets "my.custom.config" to "foo" for consumer only
 streamsProperties.put(StreamsConfig.consumerPrefix("my.custom.config"), "foo");
 // sets "my.custom.config" to "bar" for producer only
 streamsProperties.put(StreamsConfig.producerPrefix("my.custom.config"), "bar");
 // sets "my.custom.config2" to "boom" for all clients universally
 streamsProperties.put("my.custom.config2", "boom");

 // as a result, inside producer's serde class configure(..) function,
 // users can now read both key-value pairs "my.custom.config" -> "foo"
 // and "my.custom.config2" -> "boom" from the config map
 StreamsConfig streamsConfig = new StreamsConfig(streamsProperties);
 
```
When increasing ProducerConfig.MAX_BLOCK_MS_CONFIG to be more resilient to non-available brokers you should also increase ConsumerConfig.MAX_POLL_INTERVAL_MS_CONFIG using the following guidance:
```
     max.poll.interval.ms > max.block.ms
 
```
Kafka Streams requires at least the following properties to be set:
- "application.id"
- "bootstrap.servers"
By default, Kafka Streams does not allow users to overwrite the following properties (Streams setting shown in parentheses):
- "enable.auto.commit" (false) - Streams client will always disable/turn off auto committing
If "processing.guarantee" is set to "exactly_once", Kafka Streams does not allow users to overwrite the following properties (Streams setting shown in parentheses):
- "isolation.level" (read_committed) - Consumers will always read committed data only
- "enable.idempotence" (true) - Producer will always have idempotency enabled
- "max.in.flight.requests.per.connection" (5) - Producer will always have one in-flight request per connection
See Also:

KafkaStreams.KafkaStreams(org.apache.kafka.streams.Topology, Properties), ConsumerConfig, ProducerConfig

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StreamsConfig.InternalConfig

Nested Classes
Modifier and Type	Class and Description
`static class`	`StreamsConfig.InternalConfig`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADMIN_CLIENT_PREFIX` Prefix used to isolate `admin` configs from other client configs.
`static String`	`APPLICATION_ID_CONFIG` `application.id`
`static String`	`APPLICATION_SERVER_CONFIG` `user.endpoint`
`static String`	`AT_LEAST_ONCE` Config value for parameter `"processing.guarantee"` for at-least-once processing guarantees.
`static String`	`BOOTSTRAP_SERVERS_CONFIG` `bootstrap.servers`
`static String`	`BUFFERED_RECORDS_PER_PARTITION_CONFIG` `buffered.records.per.partition`
`static String`	`CACHE_MAX_BYTES_BUFFERING_CONFIG` `cache.max.bytes.buffering`
`static String`	`CLIENT_ID_CONFIG` `client.id`
`static String`	`COMMIT_INTERVAL_MS_CONFIG` `commit.interval.ms`
`static String`	`CONNECTIONS_MAX_IDLE_MS_CONFIG` `connections.max.idle.ms`
`static String`	`CONSUMER_PREFIX` Prefix used to isolate `consumer` configs from other client configs.
`static String`	`DEFAULT_DESERIALIZATION_EXCEPTION_HANDLER_CLASS_CONFIG` `default.deserialization.exception.handler`
`static String`	`DEFAULT_KEY_SERDE_CLASS_CONFIG` `default key.serde`
`static String`	`DEFAULT_PRODUCTION_EXCEPTION_HANDLER_CLASS_CONFIG` `default.production.exception.handler`
`static String`	`DEFAULT_TIMESTAMP_EXTRACTOR_CLASS_CONFIG` `default.timestamp.extractor`
`static String`	`DEFAULT_VALUE_SERDE_CLASS_CONFIG` `default value.serde`
`static String`	`DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS` `default.windowed.key.serde.inner`
`static String`	`DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS` `default.windowed.value.serde.inner`
`static int`	`DUMMY_THREAD_INDEX`
`static String`	`EXACTLY_ONCE` Config value for parameter `"processing.guarantee"` for exactly-once processing guarantees.
`static String`	`GLOBAL_CONSUMER_PREFIX` Prefix used to override `consumer` configs for the global consumer client from the general consumer client configs.
`static String`	`MAIN_CONSUMER_PREFIX` Prefix used to override `consumer` configs for the main consumer client from the general consumer client configs.
`static String`	`MAX_TASK_IDLE_MS_CONFIG` `max.task.idle.ms`
`static String`	`METADATA_MAX_AGE_CONFIG` `metadata.max.age.ms`
`static String`	`METRIC_REPORTER_CLASSES_CONFIG` `metric.reporters`
`static String`	`METRICS_NUM_SAMPLES_CONFIG` `metrics.num.samples`
`static String`	`METRICS_RECORDING_LEVEL_CONFIG` `metrics.record.level`
`static String`	`METRICS_SAMPLE_WINDOW_MS_CONFIG` `metrics.sample.window.ms`
`static String`	`NO_OPTIMIZATION` Config value for parameter (@link #TOPOLOGY_OPTIMIZATION "topology.optimization" for disabling topology optimization
`static String`	`NUM_STANDBY_REPLICAS_CONFIG` `num.standby.replicas`
`static String`	`NUM_STREAM_THREADS_CONFIG` `num.stream.threads`
`static String`	`OPTIMIZE` Config value for parameter (@link #TOPOLOGY_OPTIMIZATION "topology.optimization" for enabling topology optimization
`static String`	`PARTITION_GROUPER_CLASS_CONFIG` Deprecated.
`static String`	`POLL_MS_CONFIG` `poll.ms`
`static String`	`PROCESSING_GUARANTEE_CONFIG` `processing.guarantee`
`static String`	`PRODUCER_PREFIX` Prefix used to isolate `producer` configs from other client configs.
`static String`	`RECEIVE_BUFFER_CONFIG` `receive.buffer.bytes`
`static String`	`RECONNECT_BACKOFF_MAX_MS_CONFIG` `reconnect.backoff.max`
`static String`	`RECONNECT_BACKOFF_MS_CONFIG` `reconnect.backoff.ms`
`static String`	`REPLICATION_FACTOR_CONFIG` `replication.factor`
`static String`	`REQUEST_TIMEOUT_MS_CONFIG` `request.timeout.ms`
`static String`	`RESTORE_CONSUMER_PREFIX` Prefix used to override `consumer` configs for the restore consumer client from the general consumer client configs.
`static String`	`RETRIES_CONFIG` `retries`
`static String`	`RETRY_BACKOFF_MS_CONFIG` `retry.backoff.ms`
`static String`	`ROCKSDB_CONFIG_SETTER_CLASS_CONFIG` `rocksdb.config.setter`
`static String`	`SECURITY_PROTOCOL_CONFIG` `security.protocol`
`static String`	`SEND_BUFFER_CONFIG` `send.buffer.bytes`
`static String`	`STATE_CLEANUP_DELAY_MS_CONFIG` `state.cleanup.delay`
`static String`	`STATE_DIR_CONFIG` `state.dir`
`static String`	`TOPIC_PREFIX` Prefix used to provide default topic configs to be applied when creating internal topics.
`static String`	`TOPOLOGY_OPTIMIZATION` `topology.optimization`
`static String`	`UPGRADE_FROM_0100` Config value for parameter `"upgrade.from"` for upgrading an application from version `0.10.0.x`.
`static String`	`UPGRADE_FROM_0101` Config value for parameter `"upgrade.from"` for upgrading an application from version `0.10.1.x`.
`static String`	`UPGRADE_FROM_0102` Config value for parameter `"upgrade.from"` for upgrading an application from version `0.10.2.x`.
`static String`	`UPGRADE_FROM_0110` Config value for parameter `"upgrade.from"` for upgrading an application from version `0.11.0.x`.
`static String`	`UPGRADE_FROM_10` Config value for parameter `"upgrade.from"` for upgrading an application from version `1.0.x`.
`static String`	`UPGRADE_FROM_11` Config value for parameter `"upgrade.from"` for upgrading an application from version `1.1.x`.
`static String`	`UPGRADE_FROM_20` Config value for parameter `"upgrade.from"` for upgrading an application from version `2.0.x`.
`static String`	`UPGRADE_FROM_21` Config value for parameter `"upgrade.from"` for upgrading an application from version `2.1.x`.
`static String`	`UPGRADE_FROM_22` Config value for parameter `"upgrade.from"` for upgrading an application from version `2.2.x`.
`static String`	`UPGRADE_FROM_23` Config value for parameter `"upgrade.from"` for upgrading an application from version `2.3.x`.
`static String`	`UPGRADE_FROM_CONFIG` `upgrade.from`
`static String`	`WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_CONFIG` `windowstore.changelog.additional.retention.ms`

Fields inherited from class org.apache.kafka.common.config.AbstractConfig
CONFIG_PROVIDERS_CONFIG

Constructor Summary

Constructors
Modifier	Constructor and Description
	`StreamsConfig(Map<?,?> props)` Create a new `StreamsConfig` using the given properties.
`protected`	`StreamsConfig(Map<?,?> props, boolean doLog)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`adminClientPrefix(String adminClientProp)` Prefix a property with `ADMIN_CLIENT_PREFIX`.
`static ConfigDef`	`configDef()` Return a copy of the config definition.
`static String`	`consumerPrefix(String consumerProp)` Prefix a property with `CONSUMER_PREFIX`.
`DeserializationExceptionHandler`	`defaultDeserializationExceptionHandler()`
`Serde`	`defaultKeySerde()` Return an `configured` instance of `key Serde class`.
`ProductionExceptionHandler`	`defaultProductionExceptionHandler()`
`TimestampExtractor`	`defaultTimestampExtractor()`
`Serde`	`defaultValueSerde()` Return an `configured` instance of `value Serde class`.
`Map<String,Object>`	`getAdminConfigs(String clientId)` Get the configs for the `admin client`.
`Map<String,Object>`	`getConsumerConfigs(String groupId, String clientId)` Deprecated. use `getMainConsumerConfigs(String, String, int)`
`Map<String,Object>`	`getGlobalConsumerConfigs(String clientId)` Get the configs for the `global consumer`.
`Map<String,Object>`	`getMainConsumerConfigs(String groupId, String clientId, int threadIdx)` Get the configs to the `main consumer`.
`Map<String,Object>`	`getProducerConfigs(String clientId)` Get the configs for the `producer`.
`Map<String,Object>`	`getRestoreConsumerConfigs(String clientId)` Get the configs for the `restore-consumer`.
`static String`	`globalConsumerPrefix(String consumerProp)` Prefix a property with `GLOBAL_CONSUMER_PREFIX`.
`static void`	`main(String[] args)`
`static String`	`mainConsumerPrefix(String consumerProp)` Prefix a property with `MAIN_CONSUMER_PREFIX`.
`protected Map<String,Object>`	`postProcessParsedConfig(Map<String,Object> parsedValues)` Called directly after user configs got parsed (and thus default values got set).
`static String`	`producerPrefix(String producerProp)` Prefix a property with `PRODUCER_PREFIX`.
`static String`	`restoreConsumerPrefix(String consumerProp)` Prefix a property with `RESTORE_CONSUMER_PREFIX`.
`static String`	`topicPrefix(String topicProp)` Prefix a property with `TOPIC_PREFIX` used to provide default topic configs to be applied when creating internal topics.

Methods inherited from class org.apache.kafka.common.config.AbstractConfig
equals, get, getBoolean, getClass, getConfiguredInstance, getConfiguredInstances, getConfiguredInstances, getConfiguredInstances, getDouble, getInt, getList, getLong, getPassword, getShort, getString, hashCode, ignore, logUnused, originals, originalsStrings, originalsWithPrefix, originalsWithPrefix, typeOf, unused, values, valuesWithPrefixAllOrNothing, valuesWithPrefixOverride

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

- Field Detail
  - DUMMY_THREAD_INDEX
```
public static final int DUMMY_THREAD_INDEX
```
    See Also:
    
    Constant Field Values
  - TOPIC_PREFIX
```
public static final String TOPIC_PREFIX
```
    Prefix used to provide default topic configs to be applied when creating internal topics. These should be valid properties from TopicConfig. It is recommended to use topicPrefix(String).
    
    See Also:
    
    Constant Field Values
  - CONSUMER_PREFIX
```
public static final String CONSUMER_PREFIX
```
    Prefix used to isolate consumer configs from other client configs. It is recommended to use consumerPrefix(String) to add this prefix to consumer properties.
    
    See Also:
    
    Constant Field Values
  - MAIN_CONSUMER_PREFIX
```
public static final String MAIN_CONSUMER_PREFIX
```
    Prefix used to override consumer configs for the main consumer client from the general consumer client configs. The override precedence is the following (from highest to lowest precedence): 1. main.consumer.[config-name] 2. consumer.[config-name] 3. [config-name]
    
    See Also:
    
    Constant Field Values
  - RESTORE_CONSUMER_PREFIX
```
public static final String RESTORE_CONSUMER_PREFIX
```
    Prefix used to override consumer configs for the restore consumer client from the general consumer client configs. The override precedence is the following (from highest to lowest precedence): 1. restore.consumer.[config-name] 2. consumer.[config-name] 3. [config-name]
    
    See Also:
    
    Constant Field Values
  - GLOBAL_CONSUMER_PREFIX
```
public static final String GLOBAL_CONSUMER_PREFIX
```
    Prefix used to override consumer configs for the global consumer client from the general consumer client configs. The override precedence is the following (from highest to lowest precedence): 1. global.consumer.[config-name] 2. consumer.[config-name] 3. [config-name]
    
    See Also:
    
    Constant Field Values
  - PRODUCER_PREFIX
```
public static final String PRODUCER_PREFIX
```
    Prefix used to isolate producer configs from other client configs. It is recommended to use producerPrefix(String) to add this prefix to producer properties.
    
    See Also:
    
    Constant Field Values
  - ADMIN_CLIENT_PREFIX
```
public static final String ADMIN_CLIENT_PREFIX
```
    Prefix used to isolate admin configs from other client configs. It is recommended to use adminClientPrefix(String) to add this prefix to producer properties.
    
    See Also:
    
    Constant Field Values
  - NO_OPTIMIZATION
```
public static final String NO_OPTIMIZATION
```
    Config value for parameter (@link #TOPOLOGY_OPTIMIZATION "topology.optimization" for disabling topology optimization
    
    See Also:
    
    Constant Field Values
  - OPTIMIZE
```
public static final String OPTIMIZE
```
    Config value for parameter (@link #TOPOLOGY_OPTIMIZATION "topology.optimization" for enabling topology optimization
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_0100
```
public static final String UPGRADE_FROM_0100
```
    Config value for parameter "upgrade.from" for upgrading an application from version 0.10.0.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_0101
```
public static final String UPGRADE_FROM_0101
```
    Config value for parameter "upgrade.from" for upgrading an application from version 0.10.1.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_0102
```
public static final String UPGRADE_FROM_0102
```
    Config value for parameter "upgrade.from" for upgrading an application from version 0.10.2.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_0110
```
public static final String UPGRADE_FROM_0110
```
    Config value for parameter "upgrade.from" for upgrading an application from version 0.11.0.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_10
```
public static final String UPGRADE_FROM_10
```
    Config value for parameter "upgrade.from" for upgrading an application from version 1.0.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_11
```
public static final String UPGRADE_FROM_11
```
    Config value for parameter "upgrade.from" for upgrading an application from version 1.1.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_20
```
public static final String UPGRADE_FROM_20
```
    Config value for parameter "upgrade.from" for upgrading an application from version 2.0.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_21
```
public static final String UPGRADE_FROM_21
```
    Config value for parameter "upgrade.from" for upgrading an application from version 2.1.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_22
```
public static final String UPGRADE_FROM_22
```
    Config value for parameter "upgrade.from" for upgrading an application from version 2.2.x.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_23
```
public static final String UPGRADE_FROM_23
```
    Config value for parameter "upgrade.from" for upgrading an application from version 2.3.x.
    
    See Also:
    
    Constant Field Values
  - AT_LEAST_ONCE
```
public static final String AT_LEAST_ONCE
```
    Config value for parameter "processing.guarantee" for at-least-once processing guarantees.
    
    See Also:
    
    Constant Field Values
  - EXACTLY_ONCE
```
public static final String EXACTLY_ONCE
```
    Config value for parameter "processing.guarantee" for exactly-once processing guarantees.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_ID_CONFIG
```
public static final String APPLICATION_ID_CONFIG
```
    application.id
    
    See Also:
    
    Constant Field Values
  - APPLICATION_SERVER_CONFIG
```
public static final String APPLICATION_SERVER_CONFIG
```
    user.endpoint
    
    See Also:
    
    Constant Field Values
  - BOOTSTRAP_SERVERS_CONFIG
```
public static final String BOOTSTRAP_SERVERS_CONFIG
```
    bootstrap.servers
    
    See Also:
    
    Constant Field Values
  - BUFFERED_RECORDS_PER_PARTITION_CONFIG
```
public static final String BUFFERED_RECORDS_PER_PARTITION_CONFIG
```
    buffered.records.per.partition
    
    See Also:
    
    Constant Field Values
  - CACHE_MAX_BYTES_BUFFERING_CONFIG
```
public static final String CACHE_MAX_BYTES_BUFFERING_CONFIG
```
    cache.max.bytes.buffering
    
    See Also:
    
    Constant Field Values
  - CLIENT_ID_CONFIG
```
public static final String CLIENT_ID_CONFIG
```
    client.id
    
    See Also:
    
    Constant Field Values
  - COMMIT_INTERVAL_MS_CONFIG
```
public static final String COMMIT_INTERVAL_MS_CONFIG
```
    commit.interval.ms
    
    See Also:
    
    Constant Field Values
  - MAX_TASK_IDLE_MS_CONFIG
```
public static final String MAX_TASK_IDLE_MS_CONFIG
```
    max.task.idle.ms
    
    See Also:
    
    Constant Field Values
  - CONNECTIONS_MAX_IDLE_MS_CONFIG
```
public static final String CONNECTIONS_MAX_IDLE_MS_CONFIG
```
    connections.max.idle.ms
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DESERIALIZATION_EXCEPTION_HANDLER_CLASS_CONFIG
```
public static final String DEFAULT_DESERIALIZATION_EXCEPTION_HANDLER_CLASS_CONFIG
```
    default.deserialization.exception.handler
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PRODUCTION_EXCEPTION_HANDLER_CLASS_CONFIG
```
public static final String DEFAULT_PRODUCTION_EXCEPTION_HANDLER_CLASS_CONFIG
```
    default.production.exception.handler
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS
```
public static final String DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS
```
    default.windowed.key.serde.inner
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS
```
public static final String DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS
```
    default.windowed.value.serde.inner
    
    See Also:
    
    Constant Field Values
  - DEFAULT_KEY_SERDE_CLASS_CONFIG
```
public static final String DEFAULT_KEY_SERDE_CLASS_CONFIG
```
    default key.serde
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VALUE_SERDE_CLASS_CONFIG
```
public static final String DEFAULT_VALUE_SERDE_CLASS_CONFIG
```
    default value.serde
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMESTAMP_EXTRACTOR_CLASS_CONFIG
```
public static final String DEFAULT_TIMESTAMP_EXTRACTOR_CLASS_CONFIG
```
    default.timestamp.extractor
    
    See Also:
    
    Constant Field Values
  - METADATA_MAX_AGE_CONFIG
```
public static final String METADATA_MAX_AGE_CONFIG
```
    metadata.max.age.ms
    
    See Also:
    
    Constant Field Values
  - METRICS_NUM_SAMPLES_CONFIG
```
public static final String METRICS_NUM_SAMPLES_CONFIG
```
    metrics.num.samples
    
    See Also:
    
    Constant Field Values
  - METRICS_RECORDING_LEVEL_CONFIG
```
public static final String METRICS_RECORDING_LEVEL_CONFIG
```
    metrics.record.level
    
    See Also:
    
    Constant Field Values
  - METRIC_REPORTER_CLASSES_CONFIG
```
public static final String METRIC_REPORTER_CLASSES_CONFIG
```
    metric.reporters
    
    See Also:
    
    Constant Field Values
  - METRICS_SAMPLE_WINDOW_MS_CONFIG
```
public static final String METRICS_SAMPLE_WINDOW_MS_CONFIG
```
    metrics.sample.window.ms
    
    See Also:
    
    Constant Field Values
  - NUM_STANDBY_REPLICAS_CONFIG
```
public static final String NUM_STANDBY_REPLICAS_CONFIG
```
    num.standby.replicas
    
    See Also:
    
    Constant Field Values
  - NUM_STREAM_THREADS_CONFIG
```
public static final String NUM_STREAM_THREADS_CONFIG
```
    num.stream.threads
    
    See Also:
    
    Constant Field Values
  - POLL_MS_CONFIG
```
public static final String POLL_MS_CONFIG
```
    poll.ms
    
    See Also:
    
    Constant Field Values
  - PROCESSING_GUARANTEE_CONFIG
```
public static final String PROCESSING_GUARANTEE_CONFIG
```
    processing.guarantee
    
    See Also:
    
    Constant Field Values
  - RECEIVE_BUFFER_CONFIG
```
public static final String RECEIVE_BUFFER_CONFIG
```
    receive.buffer.bytes
    
    See Also:
    
    Constant Field Values
  - RECONNECT_BACKOFF_MS_CONFIG
```
public static final String RECONNECT_BACKOFF_MS_CONFIG
```
    reconnect.backoff.ms
    
    See Also:
    
    Constant Field Values
  - RECONNECT_BACKOFF_MAX_MS_CONFIG
```
public static final String RECONNECT_BACKOFF_MAX_MS_CONFIG
```
    reconnect.backoff.max
    
    See Also:
    
    Constant Field Values
  - REPLICATION_FACTOR_CONFIG
```
public static final String REPLICATION_FACTOR_CONFIG
```
    replication.factor
    
    See Also:
    
    Constant Field Values
  - REQUEST_TIMEOUT_MS_CONFIG
```
public static final String REQUEST_TIMEOUT_MS_CONFIG
```
    request.timeout.ms
    
    See Also:
    
    Constant Field Values
  - RETRIES_CONFIG
```
public static final String RETRIES_CONFIG
```
    retries
    
    See Also:
    
    Constant Field Values
  - RETRY_BACKOFF_MS_CONFIG
```
public static final String RETRY_BACKOFF_MS_CONFIG
```
    retry.backoff.ms
    
    See Also:
    
    Constant Field Values
  - ROCKSDB_CONFIG_SETTER_CLASS_CONFIG
```
public static final String ROCKSDB_CONFIG_SETTER_CLASS_CONFIG
```
    rocksdb.config.setter
    
    See Also:
    
    Constant Field Values
  - SECURITY_PROTOCOL_CONFIG
```
public static final String SECURITY_PROTOCOL_CONFIG
```
    security.protocol
    
    See Also:
    
    Constant Field Values
  - SEND_BUFFER_CONFIG
```
public static final String SEND_BUFFER_CONFIG
```
    send.buffer.bytes
    
    See Also:
    
    Constant Field Values
  - STATE_CLEANUP_DELAY_MS_CONFIG
```
public static final String STATE_CLEANUP_DELAY_MS_CONFIG
```
    state.cleanup.delay
    
    See Also:
    
    Constant Field Values
  - STATE_DIR_CONFIG
```
public static final String STATE_DIR_CONFIG
```
    state.dir
    
    See Also:
    
    Constant Field Values
  - TOPOLOGY_OPTIMIZATION
```
public static final String TOPOLOGY_OPTIMIZATION
```
    topology.optimization
    
    See Also:
    
    Constant Field Values
  - UPGRADE_FROM_CONFIG
```
public static final String UPGRADE_FROM_CONFIG
```
    upgrade.from
    
    See Also:
    
    Constant Field Values
  - WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_CONFIG
```
public static final String WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_CONFIG
```
    windowstore.changelog.additional.retention.ms
    
    See Also:
    
    Constant Field Values
  - PARTITION_GROUPER_CLASS_CONFIG
```
@Deprecated
public static final String PARTITION_GROUPER_CLASS_CONFIG
```
    Deprecated.
    
    partition.grouper
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StreamsConfig
```
public StreamsConfig(Map<?,?> props)
```
    Create a new StreamsConfig using the given properties.
    
    Parameters:
    
    props - properties that specify Kafka Streams and internal consumer/producer configuration
  - StreamsConfig
```
protected StreamsConfig(Map<?,?> props,
                        boolean doLog)
```
- Method Detail
  - consumerPrefix
```
public static String consumerPrefix(String consumerProp)
```
    Prefix a property with CONSUMER_PREFIX. This is used to isolate consumer configs from other client configs.
    
    Parameters:
    
    consumerProp - the consumer property to be masked
    
    Returns:
    
    CONSUMER_PREFIX + consumerProp
  - mainConsumerPrefix
```
public static String mainConsumerPrefix(String consumerProp)
```
    Prefix a property with MAIN_CONSUMER_PREFIX. This is used to isolate main consumer configs from other client configs.
    
    Parameters:
    
    consumerProp - the consumer property to be masked
    
    Returns:
    
    MAIN_CONSUMER_PREFIX + consumerProp
  - restoreConsumerPrefix
```
public static String restoreConsumerPrefix(String consumerProp)
```
    Prefix a property with RESTORE_CONSUMER_PREFIX. This is used to isolate restore consumer configs from other client configs.
    
    Parameters:
    
    consumerProp - the consumer property to be masked
    
    Returns:
    
    RESTORE_CONSUMER_PREFIX + consumerProp
  - globalConsumerPrefix
```
public static String globalConsumerPrefix(String consumerProp)
```
    Prefix a property with GLOBAL_CONSUMER_PREFIX. This is used to isolate global consumer configs from other client configs.
    
    Parameters:
    
    consumerProp - the consumer property to be masked
    
    Returns:
    
    GLOBAL_CONSUMER_PREFIX + consumerProp
  - producerPrefix
```
public static String producerPrefix(String producerProp)
```
    Prefix a property with PRODUCER_PREFIX. This is used to isolate producer configs from other client configs.
    
    Parameters:
    
    producerProp - the producer property to be masked
    
    Returns:
    
    PRODUCER_PREFIX + producerProp
  - adminClientPrefix
```
public static String adminClientPrefix(String adminClientProp)
```
    Prefix a property with ADMIN_CLIENT_PREFIX. This is used to isolate admin configs from other client configs.
    
    Parameters:
    
    adminClientProp - the admin client property to be masked
    
    Returns:
    
    ADMIN_CLIENT_PREFIX + adminClientProp
  - topicPrefix
```
public static String topicPrefix(String topicProp)
```
    Prefix a property with TOPIC_PREFIX used to provide default topic configs to be applied when creating internal topics.
    
    Parameters:
    
    topicProp - the topic property to be masked
    
    Returns:
    
    TOPIC_PREFIX + topicProp
  - configDef
```
public static ConfigDef configDef()
```
    Return a copy of the config definition.
    
    Returns:
    
    a copy of the config definition
  - postProcessParsedConfig
```
protected Map<String,Object> postProcessParsedConfig(Map<String,Object> parsedValues)
```
    Description copied from class: AbstractConfig
    
    Called directly after user configs got parsed (and thus default values got set). This allows to change default values for "secondary defaults" if required.
    
    Overrides:
    
    postProcessParsedConfig in class AbstractConfig
    
    Parameters:
    
    parsedValues - unmodifiable map of current configuration
    
    Returns:
    
    a map of updates that should be applied to the configuration (will be validated to prevent bad updates)
  - getConsumerConfigs
```
@Deprecated
public Map<String,Object> getConsumerConfigs(String groupId,
                                                         String clientId)
```
    Deprecated. use getMainConsumerConfigs(String, String, int)
    
    Get the configs to the consumer. Properties using the prefix CONSUMER_PREFIX will be used in favor over their non-prefixed versions except in the case of ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG where we always use the non-prefixed version as we only support reading/writing from/to the same Kafka Cluster.
    
    Parameters:
    
    groupId - consumer groupId
    
    clientId - clientId
    
    Returns:
    
    Map of the consumer configuration.
  - getMainConsumerConfigs
```
public Map<String,Object> getMainConsumerConfigs(String groupId,
                                                 String clientId,
                                                 int threadIdx)
```
    Get the configs to the main consumer. Properties using the prefix MAIN_CONSUMER_PREFIX will be used in favor over the properties prefixed with CONSUMER_PREFIX and the non-prefixed versions (read the override precedence ordering in MAIN_CONSUMER_PREFIX except in the case of ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG where we always use the non-prefixed version as we only support reading/writing from/to the same Kafka Cluster. If not specified by MAIN_CONSUMER_PREFIX, main consumer will share the general consumer configs prefixed by CONSUMER_PREFIX.
    
    Parameters:
    
    groupId - consumer groupId
    
    clientId - clientId
    
    threadIdx - stream thread index
    
    Returns:
    
    Map of the consumer configuration.
  - getRestoreConsumerConfigs
```
public Map<String,Object> getRestoreConsumerConfigs(String clientId)
```
    Get the configs for the restore-consumer. Properties using the prefix RESTORE_CONSUMER_PREFIX will be used in favor over the properties prefixed with CONSUMER_PREFIX and the non-prefixed versions (read the override precedence ordering in RESTORE_CONSUMER_PREFIX except in the case of ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG where we always use the non-prefixed version as we only support reading/writing from/to the same Kafka Cluster. If not specified by RESTORE_CONSUMER_PREFIX, restore consumer will share the general consumer configs prefixed by CONSUMER_PREFIX.
    
    Parameters:
    
    clientId - clientId
    
    Returns:
    
    Map of the restore consumer configuration.
  - getGlobalConsumerConfigs
```
public Map<String,Object> getGlobalConsumerConfigs(String clientId)
```
    Get the configs for the global consumer. Properties using the prefix GLOBAL_CONSUMER_PREFIX will be used in favor over the properties prefixed with CONSUMER_PREFIX and the non-prefixed versions (read the override precedence ordering in GLOBAL_CONSUMER_PREFIX except in the case of ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG where we always use the non-prefixed version as we only support reading/writing from/to the same Kafka Cluster. If not specified by GLOBAL_CONSUMER_PREFIX, global consumer will share the general consumer configs prefixed by CONSUMER_PREFIX.
    
    Parameters:
    
    clientId - clientId
    
    Returns:
    
    Map of the global consumer configuration.
  - getProducerConfigs
```
public Map<String,Object> getProducerConfigs(String clientId)
```
    Get the configs for the producer. Properties using the prefix PRODUCER_PREFIX will be used in favor over their non-prefixed versions except in the case of ProducerConfig.BOOTSTRAP_SERVERS_CONFIG where we always use the non-prefixed version as we only support reading/writing from/to the same Kafka Cluster.
    
    Parameters:
    
    clientId - clientId
    
    Returns:
    
    Map of the producer configuration.
  - getAdminConfigs
```
public Map<String,Object> getAdminConfigs(String clientId)
```
    Get the configs for the admin client.
    
    Parameters:
    
    clientId - clientId
    
    Returns:
    
    Map of the admin client configuration.
  - defaultKeySerde
```
public Serde defaultKeySerde()
```
    Return an configured instance of key Serde class.
    
    Returns:
    
    an configured instance of key Serde class
  - defaultValueSerde
```
public Serde defaultValueSerde()
```
    Return an configured instance of value Serde class.
    
    Returns:
    
    an configured instance of value Serde class
  - defaultTimestampExtractor
```
public TimestampExtractor defaultTimestampExtractor()
```
  - defaultDeserializationExceptionHandler
```
public DeserializationExceptionHandler defaultDeserializationExceptionHandler()
```
  - defaultProductionExceptionHandler
```
public ProductionExceptionHandler defaultProductionExceptionHandler()
```
  - main
```
public static void main(String[] args)
```

Class StreamsConfig

Nested Class Summary

Field Summary

Fields inherited from class org.apache.kafka.common.config.AbstractConfig

Constructor Summary

Method Summary

Methods inherited from class org.apache.kafka.common.config.AbstractConfig

Methods inherited from class java.lang.Object

Field Detail

DUMMY_THREAD_INDEX

TOPIC_PREFIX

CONSUMER_PREFIX

MAIN_CONSUMER_PREFIX

RESTORE_CONSUMER_PREFIX

GLOBAL_CONSUMER_PREFIX

PRODUCER_PREFIX

ADMIN_CLIENT_PREFIX

NO_OPTIMIZATION

OPTIMIZE

UPGRADE_FROM_0100

UPGRADE_FROM_0101

UPGRADE_FROM_0102

UPGRADE_FROM_0110

UPGRADE_FROM_10

UPGRADE_FROM_11

UPGRADE_FROM_20

UPGRADE_FROM_21

UPGRADE_FROM_22

UPGRADE_FROM_23

AT_LEAST_ONCE

EXACTLY_ONCE

APPLICATION_ID_CONFIG

APPLICATION_SERVER_CONFIG

BOOTSTRAP_SERVERS_CONFIG

BUFFERED_RECORDS_PER_PARTITION_CONFIG

CACHE_MAX_BYTES_BUFFERING_CONFIG

CLIENT_ID_CONFIG

COMMIT_INTERVAL_MS_CONFIG

MAX_TASK_IDLE_MS_CONFIG

CONNECTIONS_MAX_IDLE_MS_CONFIG

DEFAULT_DESERIALIZATION_EXCEPTION_HANDLER_CLASS_CONFIG

DEFAULT_PRODUCTION_EXCEPTION_HANDLER_CLASS_CONFIG

DEFAULT_WINDOWED_KEY_SERDE_INNER_CLASS

DEFAULT_WINDOWED_VALUE_SERDE_INNER_CLASS

DEFAULT_KEY_SERDE_CLASS_CONFIG

DEFAULT_VALUE_SERDE_CLASS_CONFIG

DEFAULT_TIMESTAMP_EXTRACTOR_CLASS_CONFIG

METADATA_MAX_AGE_CONFIG

METRICS_NUM_SAMPLES_CONFIG

METRICS_RECORDING_LEVEL_CONFIG

METRIC_REPORTER_CLASSES_CONFIG

METRICS_SAMPLE_WINDOW_MS_CONFIG

NUM_STANDBY_REPLICAS_CONFIG

NUM_STREAM_THREADS_CONFIG

POLL_MS_CONFIG

PROCESSING_GUARANTEE_CONFIG

RECEIVE_BUFFER_CONFIG

RECONNECT_BACKOFF_MS_CONFIG

RECONNECT_BACKOFF_MAX_MS_CONFIG

REPLICATION_FACTOR_CONFIG

REQUEST_TIMEOUT_MS_CONFIG

RETRIES_CONFIG

RETRY_BACKOFF_MS_CONFIG

ROCKSDB_CONFIG_SETTER_CLASS_CONFIG

SECURITY_PROTOCOL_CONFIG

SEND_BUFFER_CONFIG

STATE_CLEANUP_DELAY_MS_CONFIG

STATE_DIR_CONFIG

TOPOLOGY_OPTIMIZATION

UPGRADE_FROM_CONFIG

WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_CONFIG

PARTITION_GROUPER_CLASS_CONFIG

Constructor Detail

StreamsConfig

StreamsConfig

Method Detail

consumerPrefix

mainConsumerPrefix

restoreConsumerPrefix

globalConsumerPrefix