Package org.apache.kafka.streams.query

Class KeyQuery<K,V>

java.lang.Object
org.apache.kafka.streams.query.KeyQuery<K,V>
Type Parameters:
K - Type of keys
V - Type of values
All Implemented Interfaces:
Query<V>
@Evolving public final class KeyQuery<K,V> extends Object implements Query<V>
Interactive query for retrieving a single record based on its key.

  • Method Summary

    Modifier and Type
    Method
    Description
    K
    getKey()
    Return the key that was specified for this query.
    boolean
    isSkipCache()
    The flag whether to skip the cache or not during query evaluation.
    KeyQuery<K,V>
    skipCache()
    Specifies that the cache should be skipped during query evaluation.
    static <K, V> KeyQuery<K,V>
    withKey(K key)
    Creates a query that will retrieve the record identified by key if it exists (or null otherwise).

    Methods inherited from class java.lang.Object

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

  • Method Details

    • withKey

      public static <K, V> KeyQuery<K,V> withKey(K key)
      Creates a query that will retrieve the record identified by key if it exists (or null otherwise).
      Type Parameters:
      K - The type of the key
      V - The type of the value that will be retrieved
      Parameters:
      key - The key to retrieve

    • skipCache

      public KeyQuery<K,V> skipCache()
      Specifies that the cache should be skipped during query evaluation. This means, that the query will always get forwarded to the underlying store.

    • getKey

      public K getKey()
      Return the key that was specified for this query.
      Returns:
      The key that was specified for this query.

    • isSkipCache

      public boolean isSkipCache()
      The flag whether to skip the cache or not during query evaluation.