org.apache.kafka.streams

Class StreamsConfig

java.lang.Object

org.apache.kafka.common.config.AbstractConfig

org.apache.kafka.streams.StreamsConfig

public class StreamsConfig
extends org.apache.kafka.common.config.AbstractConfig

Configuration for Kafka Streams. Documentation for these configurations can be found in the Kafka documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamsConfig.InternalConfig

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_ID_CONFIG application.id
static java.lang.String	APPLICATION_ID_DOC
static java.lang.String	APPLICATION_SERVER_CONFIG user.endpoint
static java.lang.String	APPLICATION_SERVER_DOC
static java.lang.String	BOOTSTRAP_SERVERS_CONFIG bootstrap.servers
static java.lang.String	BUFFERED_RECORDS_PER_PARTITION_CONFIG buffered.records.per.partition
static java.lang.String	CACHE_MAX_BYTES_BUFFERING_CONFIG cache.max.bytes.buffering
static java.lang.String	CACHE_MAX_BYTES_BUFFERING_DOC
static java.lang.String	CLIENT_ID_CONFIG client.id
static java.lang.String	COMMIT_INTERVAL_MS_CONFIG commit.interval.ms
static java.lang.String	CONSUMER_PREFIX
static java.lang.String	KEY_SERDE_CLASS_CONFIG key.serde
static java.lang.String	KEY_SERDE_CLASS_DOC
static java.lang.String	METRIC_REPORTER_CLASSES_CONFIG metric.reporters
static java.lang.String	METRICS_NUM_SAMPLES_CONFIG metrics.num.samples
static java.lang.String	METRICS_SAMPLE_WINDOW_MS_CONFIG metrics.sample.window.ms
static java.lang.String	NUM_STANDBY_REPLICAS_CONFIG num.standby.replicas
static java.lang.String	NUM_STREAM_THREADS_CONFIG num.stream.threads
static java.lang.String	PARTITION_GROUPER_CLASS_CONFIG partition.grouper
static java.lang.String	POLL_MS_CONFIG poll.ms
static java.lang.String	PRODUCER_PREFIX
static java.lang.String	REPLICATION_FACTOR_CONFIG replication.factor
static java.lang.String	REPLICATION_FACTOR_DOC
static java.lang.String	ROCKSDB_CONFIG_SETTER_CLASS_CONFIG rocksdb.config.setter
static java.lang.String	ROCKSDB_CONFIG_SETTER_CLASS_DOC
static java.lang.String	STATE_CLEANUP_DELAY_MS_CONFIG state.cleanup.delay
static java.lang.String	STATE_DIR_CONFIG state.dir
static java.lang.String	TIMESTAMP_EXTRACTOR_CLASS_CONFIG timestamp.extractor
static java.lang.String	VALUE_SERDE_CLASS_CONFIG value.serde
static java.lang.String	VALUE_SERDE_CLASS_DOC
static java.lang.String	WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_CONFIG windowstore.changelog.additional.retention.ms
static java.lang.String	WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_DOC
static java.lang.String	ZOOKEEPER_CONNECT_CONFIG zookeeper.connect

Constructor Summary

Constructors

Constructor and Description
StreamsConfig(java.util.Map<?,?> props)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	consumerPrefix(java.lang.String consumerProp) Prefix a property with CONSUMER_PREFIX.
java.util.Map<java.lang.String,java.lang.Object>	getConsumerConfigs(org.apache.kafka.streams.processor.internals.StreamThread streamThread, java.lang.String groupId, java.lang.String clientId) Get the configs specific to the Consumer.
java.util.Map<java.lang.String,java.lang.Object>	getProducerConfigs(java.lang.String clientId) Get the configs for the Producer.
java.util.Map<java.lang.String,java.lang.Object>	getRestoreConsumerConfigs(java.lang.String clientId) Get the consumer config for the restore-consumer.
org.apache.kafka.common.serialization.Serde	keySerde()
static void	main(java.lang.String[] args)
static java.lang.String	producerPrefix(java.lang.String producerProp) Prefix a property with PRODUCER_PREFIX.
org.apache.kafka.common.serialization.Serde	valueSerde()

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

equals, get, getBoolean, getClass, getConfiguredInstance, getConfiguredInstances, getDouble, getInt, getList, getLong, getPassword, getShort, getString, hashCode, ignore, logUnused, originals, originalsStrings, originalsWithPrefix, unused, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONSUMER_PREFIX

public static final java.lang.String CONSUMER_PREFIX

See Also:

Constant Field Values

PRODUCER_PREFIX

public static final java.lang.String PRODUCER_PREFIX

See Also:

Constant Field Values

STATE_DIR_CONFIG

public static final java.lang.String STATE_DIR_CONFIG

state.dir

See Also:

Constant Field Values

ZOOKEEPER_CONNECT_CONFIG

public static final java.lang.String ZOOKEEPER_CONNECT_CONFIG

zookeeper.connect

See Also:

Constant Field Values

COMMIT_INTERVAL_MS_CONFIG

public static final java.lang.String COMMIT_INTERVAL_MS_CONFIG

commit.interval.ms

See Also:

Constant Field Values

POLL_MS_CONFIG

public static final java.lang.String POLL_MS_CONFIG

poll.ms

See Also:

Constant Field Values

NUM_STREAM_THREADS_CONFIG

public static final java.lang.String NUM_STREAM_THREADS_CONFIG

num.stream.threads

See Also:

Constant Field Values

NUM_STANDBY_REPLICAS_CONFIG

public static final java.lang.String NUM_STANDBY_REPLICAS_CONFIG

num.standby.replicas

See Also:

Constant Field Values

BUFFERED_RECORDS_PER_PARTITION_CONFIG

public static final java.lang.String BUFFERED_RECORDS_PER_PARTITION_CONFIG

buffered.records.per.partition

See Also:

Constant Field Values

STATE_CLEANUP_DELAY_MS_CONFIG

public static final java.lang.String STATE_CLEANUP_DELAY_MS_CONFIG

state.cleanup.delay

See Also:

Constant Field Values

TIMESTAMP_EXTRACTOR_CLASS_CONFIG

public static final java.lang.String TIMESTAMP_EXTRACTOR_CLASS_CONFIG

timestamp.extractor

See Also:

Constant Field Values

PARTITION_GROUPER_CLASS_CONFIG

public static final java.lang.String PARTITION_GROUPER_CLASS_CONFIG

partition.grouper

See Also:

Constant Field Values

APPLICATION_ID_CONFIG

public static final java.lang.String APPLICATION_ID_CONFIG

application.id

See Also:

Constant Field Values

APPLICATION_ID_DOC

public static final java.lang.String APPLICATION_ID_DOC

See Also:

Constant Field Values

REPLICATION_FACTOR_CONFIG

public static final java.lang.String REPLICATION_FACTOR_CONFIG

replication.factor

See Also:

Constant Field Values

REPLICATION_FACTOR_DOC

public static final java.lang.String REPLICATION_FACTOR_DOC

See Also:

Constant Field Values

KEY_SERDE_CLASS_CONFIG

public static final java.lang.String KEY_SERDE_CLASS_CONFIG

key.serde

See Also:

Constant Field Values

KEY_SERDE_CLASS_DOC

public static final java.lang.String KEY_SERDE_CLASS_DOC

See Also:

Constant Field Values

VALUE_SERDE_CLASS_CONFIG

public static final java.lang.String VALUE_SERDE_CLASS_CONFIG

value.serde

See Also:

Constant Field Values

VALUE_SERDE_CLASS_DOC

public static final java.lang.String VALUE_SERDE_CLASS_DOC

See Also:

Constant Field Values

APPLICATION_SERVER_CONFIG

public static final java.lang.String APPLICATION_SERVER_CONFIG

user.endpoint

See Also:

Constant Field Values

APPLICATION_SERVER_DOC

public static final java.lang.String APPLICATION_SERVER_DOC

See Also:

Constant Field Values

METRICS_SAMPLE_WINDOW_MS_CONFIG

public static final java.lang.String METRICS_SAMPLE_WINDOW_MS_CONFIG

metrics.sample.window.ms

See Also:

Constant Field Values

METRICS_NUM_SAMPLES_CONFIG

public static final java.lang.String METRICS_NUM_SAMPLES_CONFIG

metrics.num.samples

See Also:

Constant Field Values

METRIC_REPORTER_CLASSES_CONFIG

public static final java.lang.String METRIC_REPORTER_CLASSES_CONFIG

metric.reporters

See Also:

Constant Field Values

BOOTSTRAP_SERVERS_CONFIG

public static final java.lang.String BOOTSTRAP_SERVERS_CONFIG

bootstrap.servers

See Also:

Constant Field Values

CLIENT_ID_CONFIG

public static final java.lang.String CLIENT_ID_CONFIG

client.id

See Also:

Constant Field Values

ROCKSDB_CONFIG_SETTER_CLASS_CONFIG

public static final java.lang.String ROCKSDB_CONFIG_SETTER_CLASS_CONFIG

rocksdb.config.setter

See Also:

Constant Field Values

ROCKSDB_CONFIG_SETTER_CLASS_DOC

public static final java.lang.String ROCKSDB_CONFIG_SETTER_CLASS_DOC

See Also:

Constant Field Values

WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_CONFIG

public static final java.lang.String WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_CONFIG

windowstore.changelog.additional.retention.ms

See Also:

Constant Field Values

WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_DOC

public static final java.lang.String WINDOW_STORE_CHANGE_LOG_ADDITIONAL_RETENTION_MS_DOC

See Also:

Constant Field Values

CACHE_MAX_BYTES_BUFFERING_CONFIG

public static final java.lang.String CACHE_MAX_BYTES_BUFFERING_CONFIG

cache.max.bytes.buffering

See Also:

Constant Field Values

CACHE_MAX_BYTES_BUFFERING_DOC

public static final java.lang.String CACHE_MAX_BYTES_BUFFERING_DOC

See Also:

Constant Field Values

Constructor Detail

StreamsConfig

public StreamsConfig(java.util.Map<?,?> props)

Method Detail

consumerPrefix

public static java.lang.String consumerPrefix(java.lang.String consumerProp)

Prefix a property with CONSUMER_PREFIX. This is used to isolate consumer configs from producer configs

Parameters:

consumerProp -

Returns:

CONSUMER_PREFIX + consumerProp

producerPrefix

public static java.lang.String producerPrefix(java.lang.String producerProp)

Prefix a property with PRODUCER_PREFIX. This is used to isolate producer configs from consumer configs

Parameters:

producerProp -

Returns:

PRODUCER_PREFIX + consumerProp

getConsumerConfigs

public java.util.Map<java.lang.String,java.lang.Object> getConsumerConfigs(org.apache.kafka.streams.processor.internals.StreamThread streamThread,
                                                                           java.lang.String groupId,
                                                                           java.lang.String clientId)
                                                                    throws org.apache.kafka.common.config.ConfigException

Get the configs specific 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:

streamThread - the StreamThread creating a consumer

groupId - consumer groupId

clientId - clientId

Returns:

Map of the Consumer configuration.

Throws:

org.apache.kafka.common.config.ConfigException

getRestoreConsumerConfigs

public java.util.Map<java.lang.String,java.lang.Object> getRestoreConsumerConfigs(java.lang.String clientId)
                                                                           throws org.apache.kafka.common.config.ConfigException

Get the consumer config for the restore-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:

clientId - clientId

Returns:

Map of the Consumer configuration

Throws:

org.apache.kafka.common.config.ConfigException

getProducerConfigs

public java.util.Map<java.lang.String,java.lang.Object> getProducerConfigs(java.lang.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 Consumer configuration

Throws:

org.apache.kafka.common.config.ConfigException

keySerde

public org.apache.kafka.common.serialization.Serde keySerde()

valueSerde

public org.apache.kafka.common.serialization.Serde valueSerde()

main

public static void main(java.lang.String[] args)