Package org.apache.kafka.streams.state
Interface WindowBytesStoreSupplier
-
- All Superinterfaces:
StoreSupplier<WindowStore<org.apache.kafka.common.utils.Bytes,byte[]>>
public interface WindowBytesStoreSupplier extends StoreSupplier<WindowStore<org.apache.kafka.common.utils.Bytes,byte[]>>
A store supplier that can be used to create one or moreWindowStore<Byte, byte[]>
instances of type <Byte, byte[]>. For any stores implementing theWindowStore<Byte, byte[]>
interface, null value bytes are considered as "not exist". This means: 1. Null value bytes in put operations should be treated as delete. 2. Null value bytes should never be returned in range query results.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
retainDuplicates()
Whether or not this store is retaining duplicate keys.long
retentionPeriod()
The time period for which theWindowStore
will retain historic data.long
segmentIntervalMs()
The size of the segments (in milliseconds) the store has.int
segments()
Deprecated.since 2.1.long
windowSize()
The size of the windows (in milliseconds) any store created from this supplier is creating.-
Methods inherited from interface org.apache.kafka.streams.state.StoreSupplier
get, metricsScope, name
-
-
-
-
Method Detail
-
segments
@Deprecated int segments()
Deprecated.since 2.1. UsesegmentIntervalMs()
instead.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.- Returns:
- number of segments
-
segmentIntervalMs
long segmentIntervalMs()
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.- Returns:
- size of the segments (in milliseconds)
-
windowSize
long windowSize()
The size of the windows (in milliseconds) any store created from this supplier is creating.- Returns:
- window size
-
retainDuplicates
boolean retainDuplicates()
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.- Returns:
- true if duplicates should be retained
-
retentionPeriod
long retentionPeriod()
The time period for which theWindowStore
will retain historic data.- Returns:
- retentionPeriod
-
-