Package org.apache.kafka.streams.state.internals

Class AbstractStoreBuilder<K,V,T extends StateStore>

java.lang.Object

org.apache.kafka.streams.state.internals.AbstractStoreBuilder<K,V,T>

All Implemented Interfaces:

StoreBuilder<T>

Direct Known Subclasses:

KeyValueStoreBuilder, SessionStoreBuilder, TimestampedKeyValueStoreBuilder, TimestampedWindowStoreBuilder, WindowStoreBuilder

public abstract class AbstractStoreBuilder<K,V,T extends StateStore>
extends java.lang.Object
implements StoreBuilder<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	name

Constructor Summary

Constructors

Constructor	Description
AbstractStoreBuilder(java.lang.String name, org.apache.kafka.common.serialization.Serde<K> keySerde, org.apache.kafka.common.serialization.Serde<V> valueSerde, org.apache.kafka.common.utils.Time time)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	logConfig()	Returns a Map containing any log configs that will be used when creating the changelog for the StateStore.
boolean	loggingEnabled()
java.lang.String	name()	Return the name of this state store builder.
StoreBuilder<T>	withCachingDisabled()	Disable caching on the store.
StoreBuilder<T>	withCachingEnabled()	Enable caching on the store.
StoreBuilder<T>	withLoggingDisabled()	Disable the changelog for store built by this StoreBuilder.
StoreBuilder<T>	withLoggingEnabled(java.util.Map<java.lang.String,java.lang.String> config)	Maintain a changelog for any changes made to the store.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.streams.state.StoreBuilder

build

Field Detail

name

protected final java.lang.String name

Constructor Detail

AbstractStoreBuilder

public AbstractStoreBuilder(java.lang.String name,
                            org.apache.kafka.common.serialization.Serde<K> keySerde,
                            org.apache.kafka.common.serialization.Serde<V> valueSerde,
                            org.apache.kafka.common.utils.Time time)

Method Detail

withCachingEnabled

public StoreBuilder<T> withCachingEnabled()

Description copied from interface: StoreBuilder

Enable caching on the store.

Specified by:

withCachingEnabled in interface StoreBuilder<K>

Returns:

this

withCachingDisabled

public StoreBuilder<T> withCachingDisabled()

Description copied from interface: StoreBuilder

Disable caching on the store.

Specified by:

withCachingDisabled in interface StoreBuilder<K>

Returns:

this

withLoggingEnabled

public StoreBuilder<T> withLoggingEnabled(java.util.Map<java.lang.String,java.lang.String> config)

Description copied from interface: StoreBuilder

Maintain a changelog for any changes made to the store. Use the provided config to set the config of the changelog topic.

Specified by:

withLoggingEnabled in interface StoreBuilder<K>

Parameters:

config - config applied to the changelog topic

Returns:

this

withLoggingDisabled

public StoreBuilder<T> withLoggingDisabled()

Description copied from interface: StoreBuilder

Disable the changelog for store built by this StoreBuilder. This will turn off fault-tolerance for your store. By default the changelog is enabled.

Specified by:

withLoggingDisabled in interface StoreBuilder<K>

Returns:

this

logConfig

public java.util.Map<java.lang.String,java.lang.String> logConfig()

Description copied from interface: StoreBuilder

Returns a Map containing any log configs that will be used when creating the changelog for the StateStore.

Note: any unrecognized configs will be ignored by the Kafka brokers.

Specified by:

logConfig in interface StoreBuilder<K>

Returns:

Map containing any log configs to be used when creating the changelog for the StateStore If loggingEnabled returns false, this function will always return an empty map

loggingEnabled

public boolean loggingEnabled()

Specified by:

loggingEnabled in interface StoreBuilder<K>

Returns:

true if the StateStore should have logging enabled

name

public java.lang.String name()

Description copied from interface: StoreBuilder

Return the name of this state store builder. This must be a valid Kafka topic name; valid characters are ASCII alphanumerics, '.', '_' and '-'.

Specified by:

name in interface StoreBuilder<K>

Returns:

the name of this state store builder