Package org.apache.kafka.streams

Class TopologyConfig

java.lang.Object

org.apache.kafka.common.config.AbstractConfig

org.apache.kafka.streams.TopologyConfig

public final class TopologyConfig
extends AbstractConfig

Streams configs that apply at the topology level. The values in the StreamsConfig parameter of the KafkaStreams constructor or the KafkaStreamsNamedTopologyWrapper constructor (deprecated) will determine the defaults, which can then be overridden for specific topologies by passing them in when creating the topology builders via the StreamsBuilder(TopologyConfig) constructor for DSL applications, or the Topology(TopologyConfig) for PAPI applications.

Note that some configs, such as the processor.wrapper.class config, can only take effect while the topology is being built, which means they have to be passed in as a TopologyConfig to the Topology(TopologyConfig) constructor (PAPI) or the StreamsBuilder(TopologyConfig) constructor (DSL). If they are only set in the configs passed in to the KafkaStreams constructor, it will be too late for them to be applied and the config will be ignored.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TopologyConfig.InternalConfig
static class	TopologyConfig.TaskConfig

Field Summary

Fields

Modifier and Type	Field	Description
final StreamsConfig	applicationConfigs
final long	cacheSize
final Supplier<DeserializationExceptionHandler>	deserializationExceptionHandlerSupplier
final Class<?>	dslStoreSuppliers
final boolean	eosEnabled
final int	maxBufferedSize
final long	maxTaskIdleMs
final Supplier<ProcessingExceptionHandler>	processingExceptionHandlerSupplier
final String	storeType
final long	taskTimeoutMs
final Supplier<TimestampExtractor>	timestampExtractorSupplier
final String	topologyName
final Properties	topologyOverrides

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

AUTOMATIC_CONFIG_PROVIDERS_PROPERTY, CONFIG_PROVIDERS_CONFIG

Constructor Summary

Constructors

Constructor	Description
TopologyConfig(String topologyName, StreamsConfig globalAppConfigs, Properties topologyOverrides)
TopologyConfig(StreamsConfig configs)

Method Summary

Modifier and Type	Method	Description
TopologyConfig.TaskConfig	getTaskConfig()
boolean	isNamedTopology()
Materialized.StoreType	parseStoreType()	Deprecated.
Optional<DslStoreSuppliers>	resolveDslStoreSuppliers()

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

documentationOf, equals, getBoolean, getClass, getConfiguredInstance, getConfiguredInstance, getConfiguredInstances, getConfiguredInstances, getConfiguredInstances, getDouble, getInt, getList, getLong, getPassword, getShort, getString, hashCode, ignore, logUnused, nonInternalValues, originals, originals, originalsStrings, originalsWithPrefix, originalsWithPrefix, typeOf, unused, values, valuesWithPrefixAllOrNothing, valuesWithPrefixOverride

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

topologyName

public final String topologyName

eosEnabled

public final boolean eosEnabled

applicationConfigs

public final StreamsConfig applicationConfigs

topologyOverrides

public final Properties topologyOverrides

maxBufferedSize

public final int maxBufferedSize

cacheSize

public final long cacheSize

maxTaskIdleMs

public final long maxTaskIdleMs

taskTimeoutMs

public final long taskTimeoutMs

storeType

public final String storeType

dslStoreSuppliers

public final Class<?> dslStoreSuppliers

timestampExtractorSupplier

public final Supplier<TimestampExtractor> timestampExtractorSupplier

deserializationExceptionHandlerSupplier

public final Supplier<DeserializationExceptionHandler> deserializationExceptionHandlerSupplier

processingExceptionHandlerSupplier

public final Supplier<ProcessingExceptionHandler> processingExceptionHandlerSupplier

Constructor Details

TopologyConfig

public TopologyConfig(StreamsConfig configs)

TopologyConfig

public TopologyConfig(String topologyName,
 StreamsConfig globalAppConfigs,
 Properties topologyOverrides)

Method Details

parseStoreType

@Deprecated
public Materialized.StoreType parseStoreType()

Deprecated.

resolveDslStoreSuppliers

public Optional<DslStoreSuppliers> resolveDslStoreSuppliers()

Returns:

the DslStoreSuppliers if the value was explicitly configured (either by StreamsConfig.DEFAULT_DSL_STORE or StreamsConfig.DSL_STORE_SUPPLIERS_CLASS_CONFIG)

isNamedTopology

public boolean isNamedTopology()

getTaskConfig

public TopologyConfig.TaskConfig getTaskConfig()