Class UnlimitedWindows

    • Field Summary

      Fields 
      Modifier and Type Field Description
      long startMs
      The start timestamp of the window.
      • Fields inherited from class org.apache.kafka.streams.kstream.Windows

        segments
    • Field Detail

      • startMs

        public final long startMs
        The start timestamp of the window.
    • Method Detail

      • of

        public static UnlimitedWindows of()
        Return an unlimited window starting at timestamp zero.
      • startOn

        @Deprecated
        public UnlimitedWindows startOn​(long startMs)
                                 throws java.lang.IllegalArgumentException
        Deprecated.
        Use startOn(Instant) instead
        Return a new unlimited window for the specified start timestamp.
        Parameters:
        startMs - the window start time
        Returns:
        a new unlimited window that starts at startMs
        Throws:
        java.lang.IllegalArgumentException - if the start time is negative
      • startOn

        public UnlimitedWindows startOn​(java.time.Instant start)
                                 throws java.lang.IllegalArgumentException
        Return a new unlimited window for the specified start timestamp.
        Parameters:
        start - the window start time
        Returns:
        a new unlimited window that starts at start
        Throws:
        java.lang.IllegalArgumentException - if the start time is negative or can't be represented as long milliseconds
      • windowsFor

        public java.util.Map<java.lang.Long,​UnlimitedWindow> windowsFor​(long timestamp)
        Description copied from class: Windows
        Create all windows that contain the provided timestamp, indexed by non-negative window start timestamps.
        Specified by:
        windowsFor in class Windows<UnlimitedWindow>
        Parameters:
        timestamp - the timestamp window should get created for
        Returns:
        a map of windowStartTimestamp -> Window entries
      • size

        public long size()
        Return the size of the specified windows in milliseconds. As unlimited windows have conceptually infinite size, this methods just returns Long.MAX_VALUE.
        Specified by:
        size in class Windows<UnlimitedWindow>
        Returns:
        the size of the specified windows which is Long.MAX_VALUE
      • until

        @Deprecated
        public UnlimitedWindows until​(long durationMs)
        Deprecated.
        since 2.1.
        Throws an IllegalArgumentException because the retention time for unlimited windows is always infinite and cannot be changed.
        Overrides:
        until in class Windows<UnlimitedWindow>
        Parameters:
        durationMs - the window retention time in milliseconds
        Returns:
        itself
        Throws:
        java.lang.IllegalArgumentException - on every invocation.
      • maintainMs

        @Deprecated
        public long maintainMs()
        Deprecated.
        since 2.1. Use Materialized.retention instead.
        Return the window maintain duration (retention time) in milliseconds. The retention time for unlimited windows in infinite and thus represented as Long.MAX_VALUE.
        Overrides:
        maintainMs in class Windows<UnlimitedWindow>
        Returns:
        the window retention time that is Long.MAX_VALUE
      • gracePeriodMs

        public long gracePeriodMs()
        Description copied from class: Windows
        Return the window grace period (the time to admit out-of-order events after the end of the window.) Delay is defined as (stream_time - record_timestamp).
        Specified by:
        gracePeriodMs in class Windows<UnlimitedWindow>
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object