Package org.apache.kafka.streams.state

Class DslWindowParams

java.lang.Object
org.apache.kafka.streams.state.DslWindowParams
public class DslWindowParams extends Object
DslWindowParams is a wrapper class for all parameters that function as inputs to DslStoreSuppliers.windowStore(DslWindowParams).

  • Constructor Details

    • DslWindowParams

      @Deprecated public DslWindowParams(String name, Duration retentionPeriod, Duration windowSize, boolean retainDuplicates, EmitStrategy emitStrategy, boolean isSlidingWindow, boolean isTimestamped)
      Deprecated.
      Since 4.3. Use DslWindowParams(String, Duration, Duration, boolean, EmitStrategy, boolean, DslStoreFormat) Params(String, DslStoreFormat)} instead.
      Parameters:
      name - name of the store (cannot be null)
      retentionPeriod - length of time to retain data in the store (cannot be negative) (note that the retention period must be at least long enough to contain the windowed data's entire life cycle, from window-start through window-end, and for the entire grace period)
      windowSize - size of the windows (cannot be negative)
      retainDuplicates - whether to retain duplicates. Turning this on will automatically disable caching and means that null values will be ignored.
      emitStrategy - defines how to emit results
      isSlidingWindow - whether the requested store is a sliding window
      isTimestamped - whether the requested store should be timestamped (see TimestampedWindowStore

    • DslWindowParams

      public DslWindowParams(String name, Duration retentionPeriod, Duration windowSize, boolean retainDuplicates, EmitStrategy emitStrategy, boolean isSlidingWindow, DslStoreFormat dslStoreFormat)
      Parameters:
      name - name of the store (cannot be null)
      retentionPeriod - length of time to retain data in the store (cannot be negative) (note that the retention period must be at least long enough to contain the windowed data's entire life cycle, from window-start through window-end, and for the entire grace period)
      windowSize - size of the windows (cannot be negative)
      retainDuplicates - whether to retain duplicates. Turning this on will automatically disable caching and means that null values will be ignored.
      emitStrategy - defines how to emit results
      isSlidingWindow - whether the requested store is a sliding window
      dslStoreFormat - indicate the dsl store format (see DslStoreFormat

  • Method Details

    • name

      public String name()

    • retentionPeriod

      public Duration retentionPeriod()

    • windowSize

      public Duration windowSize()

    • retainDuplicates

      public boolean retainDuplicates()

    • emitStrategy

      public EmitStrategy emitStrategy()

    • isSlidingWindow

      public boolean isSlidingWindow()

    • isTimestamped

      @Deprecated public boolean isTimestamped()
      Deprecated.
      Since 4.3. Use dslStoreFormat() instead to check the store format.
      Returns:
      true if the store format is DslStoreFormat.TIMESTAMPED, false otherwise

    • dslStoreFormat

      public DslStoreFormat dslStoreFormat()
      Returns the store format for this window store. `
      Returns:
      the DslStoreFormat specifying whether to use plain, timestamped, or headers-aware stores

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object