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

Class RocksDbWindowBytesStoreSupplier

java.lang.Object

org.apache.kafka.streams.state.internals.RocksDbWindowBytesStoreSupplier

All Implemented Interfaces:

StoreSupplier<WindowStore<org.apache.kafka.common.utils.Bytes,byte[]>>, WindowBytesStoreSupplier

public class RocksDbWindowBytesStoreSupplier
extends java.lang.Object
implements WindowBytesStoreSupplier

Constructor Summary

Constructors

Constructor	Description
RocksDbWindowBytesStoreSupplier(java.lang.String name, long retentionPeriod, long segmentInterval, long windowSize, boolean retainDuplicates, boolean returnTimestampedStore)

Method Summary

Modifier and Type	Method	Description
WindowStore<org.apache.kafka.common.utils.Bytes,byte[]>	get()	Return a new StateStore instance.
java.lang.String	metricsScope()	Return a String that is used as the scope for metrics recorded by Metered stores.
java.lang.String	name()	Return the name of this state store supplier.
boolean	retainDuplicates()	Whether or not this store is retaining duplicate keys.
long	retentionPeriod()	The time period for which the WindowStore will retain historic data.
long	segmentIntervalMs()	The size of the segments (in milliseconds) the store has.
int	segments()	Deprecated.
long	windowSize()	The size of the windows (in milliseconds) any store created from this supplier is creating.

Methods inherited from class java.lang.Object

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

Constructor Detail

RocksDbWindowBytesStoreSupplier

public RocksDbWindowBytesStoreSupplier(java.lang.String name,
                                       long retentionPeriod,
                                       long segmentInterval,
                                       long windowSize,
                                       boolean retainDuplicates,
                                       boolean returnTimestampedStore)

Method Detail

name

public java.lang.String name()

Description copied from interface: StoreSupplier

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

Specified by:

name in interface StoreSupplier<WindowStore<org.apache.kafka.common.utils.Bytes,byte[]>>

Returns:

the name of this state store supplier

get

public WindowStore<org.apache.kafka.common.utils.Bytes,byte[]> get()

Description copied from interface: StoreSupplier

Return a new StateStore instance.

Specified by:

get in interface StoreSupplier<WindowStore<org.apache.kafka.common.utils.Bytes,byte[]>>

Returns:

a new StateStore instance of type T

metricsScope

public java.lang.String metricsScope()

Description copied from interface: StoreSupplier

Return a String that is used as the scope for metrics recorded by Metered stores.

Specified by:

metricsScope in interface StoreSupplier<WindowStore<org.apache.kafka.common.utils.Bytes,byte[]>>

Returns:

metricsScope

segments

@Deprecated
public int segments()

Deprecated.

Description copied from interface: WindowBytesStoreSupplier

The number of segments the store has. If your store is segmented then this should be the number of segments in the underlying store. It is also used to reduce the amount of data that is scanned when caching is enabled.

Specified by:

segments in interface WindowBytesStoreSupplier

Returns:

number of segments

segmentIntervalMs

public long segmentIntervalMs()

Description copied from interface: WindowBytesStoreSupplier

The size of the segments (in milliseconds) the store has. If your store is segmented then this should be the size of segments in the underlying store. It is also used to reduce the amount of data that is scanned when caching is enabled.

Specified by:

segmentIntervalMs in interface WindowBytesStoreSupplier

Returns:

size of the segments (in milliseconds)

windowSize

public long windowSize()

Description copied from interface: WindowBytesStoreSupplier

The size of the windows (in milliseconds) any store created from this supplier is creating.

Specified by:

windowSize in interface WindowBytesStoreSupplier

Returns:

window size

retainDuplicates

public boolean retainDuplicates()

Description copied from interface: WindowBytesStoreSupplier

Whether or not this store is retaining duplicate keys. Usually only true if the store is being used for joins. Note this should return false if caching is enabled.

Specified by:

retainDuplicates in interface WindowBytesStoreSupplier

Returns:

true if duplicates should be retained

retentionPeriod

public long retentionPeriod()

Description copied from interface: WindowBytesStoreSupplier

The time period for which the WindowStore will retain historic data.

Specified by:

retentionPeriod in interface WindowBytesStoreSupplier

Returns:

retentionPeriod