Package org.apache.kafka.streams.state

Interface StoreSupplier<T extends StateStore>

Type Parameters:
T - State store type
All Known Subinterfaces:
KeyValueBytesStoreSupplier, SessionBytesStoreSupplier, VersionedBytesStoreSupplier, WindowBytesStoreSupplier
public interface StoreSupplier<T extends StateStore>
A state store supplier which can create one or more StateStore instances.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    get()
    Return a new StateStore instance.
    String
    metricsScope()
    Return a String that is used as the scope for metrics recorded by Metered stores.
    String
    name()
    Return the name of this state store supplier.

  • Method Details

    • name

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

    • get

      T get()
      Return a new StateStore instance.
      Returns:
      a new StateStore instance of type T

    • metricsScope

      String metricsScope()
      Return a String that is used as the scope for metrics recorded by Metered stores.
      Returns:
      metricsScope