org.apache.kafka.streams.kstream

Class Windows<W extends Window>

java.lang.Object

org.apache.kafka.streams.kstream.Windows<W>

Type Parameters:

W - type of the window instance

Direct Known Subclasses:

JoinWindows, TimeWindows, UnlimitedWindows

public abstract class Windows<W extends Window>
extends java.lang.Object

The window specification interface that can be extended for windowing operation in joins and aggregations.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name
int	segments

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Windows(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
long	maintainMs() Return the window maintain duration in milliseconds of system time.
java.lang.String	name()
protected Windows	segments(int segments) Specify the number of segments to be used for rolling the window store, this function is not exposed to users but can be called by developers that extend this JoinWindows specs.
Windows	until(long durationMs) Set the window maintain duration in milliseconds of system time.
abstract java.util.Map<java.lang.Long,W>	windowsFor(long timestamp) Creates all windows that contain the provided timestamp.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

segments

public int segments

Constructor Detail

Windows

protected Windows(java.lang.String name)

Method Detail

name

public java.lang.String name()

until

public Windows until(long durationMs)

Set the window maintain duration in milliseconds of system time.

Returns:

itself

segments

protected Windows segments(int segments)

Specify the number of segments to be used for rolling the window store, this function is not exposed to users but can be called by developers that extend this JoinWindows specs.

Returns:

itself

maintainMs

public long maintainMs()

Return the window maintain duration in milliseconds of system time.

Returns:

the window maintain duration in milliseconds of system time

windowsFor

public abstract java.util.Map<java.lang.Long,W> windowsFor(long timestamp)

Creates all windows that contain the provided timestamp.

Parameters:

timestamp - the timestamp window should get created for

Returns:

a map of windowStartTimestamp -> Window entries