Package org.apache.kafka.streams
Class StoreQueryParameters<T>
java.lang.Object
org.apache.kafka.streams.StoreQueryParameters<T>
StoreQueryParameters
allows you to pass a variety of parameters when fetching a store for interactive query.-
Constructor Summary
ModifierConstructorDescriptionprotected
StoreQueryParameters
(String storeName, QueryableStoreType<T> queryableStoreType, Integer partition, boolean staleStores) -
Method Summary
Modifier and TypeMethodDescriptionEnable querying of stale state stores, i.e., allow to query active tasks during restore as well as standby tasks.boolean
static <T> StoreQueryParameters<T>
fromNameAndType
(String storeName, QueryableStoreType<T> queryableStoreType) int
hashCode()
Get the store partition that will be queried.Get the queryable store type for which key is queried by the user.boolean
Get the flag staleStores.Get the name of the state store that should be queried.toString()
withPartition
(Integer partition) Set a specific partition that should be queried exclusively.
-
Constructor Details
-
StoreQueryParameters
protected StoreQueryParameters(String storeName, QueryableStoreType<T> queryableStoreType, Integer partition, boolean staleStores)
-
-
Method Details
-
fromNameAndType
public static <T> StoreQueryParameters<T> fromNameAndType(String storeName, QueryableStoreType<T> queryableStoreType) -
withPartition
Set a specific partition that should be queried exclusively.- Parameters:
partition
- The specific integer partition to be fetched from the stores list by usingStoreQueryParameters
.- Returns:
- StoreQueryParameters a new
StoreQueryParameters
instance configured with the specified partition
-
enableStaleStores
Enable querying of stale state stores, i.e., allow to query active tasks during restore as well as standby tasks.- Returns:
- StoreQueryParameters a new
StoreQueryParameters
instance configured with serving from stale stores enabled
-
storeName
Get the name of the state store that should be queried.- Returns:
- String state store name
-
queryableStoreType
Get the queryable store type for which key is queried by the user.- Returns:
- QueryableStoreType type of queryable store
-
partition
Get the store partition that will be queried. If the method returnsnull
, it would mean that no specific partition has been requested, so all the local partitions for the store will be queried.- Returns:
- Integer partition
-
staleStoresEnabled
public boolean staleStoresEnabled()Get the flag staleStores. Iftrue
, include standbys and recovering stores along with running stores.- Returns:
- boolean staleStores
-
equals
-
toString
-
hashCode
public int hashCode()
-