org.apache.flink.streaming.api.windowing.helper

Class Time<DATA>

java.lang.Object

org.apache.flink.streaming.api.windowing.helper.WindowingHelper<DATA>

org.apache.flink.streaming.api.windowing.helper.Time<DATA>

Type Parameters:

DATA - The data type which is handled by the time stamp used in the policy represented by this helper

public class Time<DATA>
extends WindowingHelper<DATA>

This helper represents a time based count or eviction policy. By default the time is measured with System.currentTimeMillis() in SystemTimestamp.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	delay
protected TimeUnit	granularity
protected long	length
protected TimestampWrapper<DATA>	timestampWrapper

Fields inherited from class org.apache.flink.streaming.api.windowing.helper.WindowingHelper

executionConfig

Method Summary

Modifier and Type	Method and Description
protected long	granularityInMillis()
static <DATA> Time<DATA>	of(long length, Timestamp<DATA> timestamp) Creates a helper representing a time trigger which triggers every given length (slide size) or a time eviction which evicts all elements older than length (window size) using a user defined timestamp extractor.
static <DATA> Time<DATA>	of(long length, Timestamp<DATA> timestamp, long startTime) Creates a helper representing a time trigger which triggers every given length (slide size) or a time eviction which evicts all elements older than length (window size) using a user defined timestamp extractor.
static <DATA> Time<DATA>	of(long length, TimeUnit timeUnit) Creates a helper representing a time trigger which triggers every given length (slide size) or a time eviction which evicts all elements older than length (window size) using System time.
EvictionPolicy<DATA>	toEvict() Method for encapsulating the EvictionPolicy.
TriggerPolicy<DATA>	toTrigger() Method for encapsulating the TriggerPolicy.

Methods inherited from class org.apache.flink.streaming.api.windowing.helper.WindowingHelper

setExecutionConfig

Methods inherited from class java.lang.Object

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

Field Detail

length

protected long length

granularity

protected TimeUnit granularity

timestampWrapper

protected TimestampWrapper<DATA> timestampWrapper

delay

protected long delay

Method Detail

toEvict

public EvictionPolicy<DATA> toEvict()

Description copied from class: WindowingHelper

Method for encapsulating the EvictionPolicy.

Specified by:

toEvict in class WindowingHelper<DATA>

Returns:

the eviction policy

toTrigger

public TriggerPolicy<DATA> toTrigger()

Description copied from class: WindowingHelper

Method for encapsulating the TriggerPolicy.

Specified by:

toTrigger in class WindowingHelper<DATA>

Returns:

the trigger policy

of

public static <DATA> Time<DATA> of(long length,
                                   TimeUnit timeUnit)

Creates a helper representing a time trigger which triggers every given length (slide size) or a time eviction which evicts all elements older than length (window size) using System time.

Parameters:

length - The number of time units

timeUnit - The unit of time such as minute oder millisecond. Note that the smallest possible granularity is milliseconds. Any smaller time unit might cause an error at runtime due to conversion problems.

Returns:

Helper representing the time based trigger and eviction policy

of

public static <DATA> Time<DATA> of(long length,
                                   Timestamp<DATA> timestamp,
                                   long startTime)

Creates a helper representing a time trigger which triggers every given length (slide size) or a time eviction which evicts all elements older than length (window size) using a user defined timestamp extractor.

Parameters:

length - The number of time units

timestamp - The user defined timestamp that will be used to extract time information from the incoming elements

startTime - The startTime used to compute the first window

Returns:

Helper representing the time based trigger and eviction policy

of

public static <DATA> Time<DATA> of(long length,
                                   Timestamp<DATA> timestamp)

Creates a helper representing a time trigger which triggers every given length (slide size) or a time eviction which evicts all elements older than length (window size) using a user defined timestamp extractor. By default the start time is set to 0.

Parameters:

length - The number of time units

timestamp - The user defined timestamp that will be used to extract time information from the incoming elements

Returns:

Helper representing the time based trigger and eviction policy

granularityInMillis

protected long granularityInMillis()