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 Object implements StoreBuilder<T>
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>
logConfig()
Returns a Map containing any log configs that will be used when creating the changelog for theStateStore
.boolean
loggingEnabled()
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 thisStoreBuilder
.StoreBuilder<T>
withLoggingEnabled(Map<String,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 String name
-
-
Method Detail
-
withCachingEnabled
public StoreBuilder<T> withCachingEnabled()
Description copied from interface:StoreBuilder
Enable caching on the store.- Specified by:
withCachingEnabled
in interfaceStoreBuilder<K>
- Returns:
- this
-
withCachingDisabled
public StoreBuilder<T> withCachingDisabled()
Description copied from interface:StoreBuilder
Disable caching on the store.- Specified by:
withCachingDisabled
in interfaceStoreBuilder<K>
- Returns:
- this
-
withLoggingEnabled
public StoreBuilder<T> withLoggingEnabled(Map<String,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 interfaceStoreBuilder<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 thisStoreBuilder
. This will turn off fault-tolerance for your store. By default the changelog is enabled.- Specified by:
withLoggingDisabled
in interfaceStoreBuilder<K>
- Returns:
- this
-
logConfig
public Map<String,String> logConfig()
Description copied from interface:StoreBuilder
Returns a Map containing any log configs that will be used when creating the changelog for theStateStore
.Note: any unrecognized configs will be ignored by the Kafka brokers.
- Specified by:
logConfig
in interfaceStoreBuilder<K>
- Returns:
- Map containing any log configs to be used when creating the changelog for the
StateStore
IfloggingEnabled
returns false, this function will always return an empty map
-
loggingEnabled
public boolean loggingEnabled()
- Specified by:
loggingEnabled
in interfaceStoreBuilder<K>
- Returns:
true
if theStateStore
should have logging enabled
-
name
public 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 interfaceStoreBuilder<K>
- Returns:
- the name of this state store builder
-
-