org.apache.flink.streaming.api.windowing.time

Class Time

java.lang.Object

org.apache.flink.streaming.api.windowing.time.Time

@Public
public final class Time
extends Object

The definition of a time interval for windowing. The time characteristic referred to is the default time characteristic set on the execution environment.

Method Summary

Modifier and Type	Method and Description
static Time	days(long days) Creates a new Time that represents the given number of days.
long	getSize() Gets the length of this policy's time interval.
TimeUnit	getUnit() Gets the time unit for this policy's time interval.
static Time	hours(long hours) Creates a new Time that represents the given number of hours.
static Time	milliseconds(long milliseconds) Creates a new Time that represents the given number of milliseconds.
static Time	minutes(long minutes) Creates a new Time that represents the given number of minutes.
static Time	of(long size, TimeUnit unit) Creates a new Time of the given duration and TimeUnit.
static Time	seconds(long seconds) Creates a new Time that represents the given number of seconds.
long	toMilliseconds() Converts the time interval to milliseconds.

Methods inherited from class java.lang.Object

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

Method Detail

getUnit

public TimeUnit getUnit()

Gets the time unit for this policy's time interval.

Returns:

The time unit for this policy's time interval.

getSize

public long getSize()

Gets the length of this policy's time interval.

Returns:

The length of this policy's time interval.

toMilliseconds

public long toMilliseconds()

Converts the time interval to milliseconds.

Returns:

The time interval in milliseconds.

of

public static Time of(long size,
                      TimeUnit unit)

Creates a new Time of the given duration and TimeUnit.

The Time refers to the time characteristic that is set on the dataflow via StreamExecutionEnvironment.setStreamTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic).

Parameters:

size - The duration of time.

unit - The unit of time of the duration, for example TimeUnit.SECONDS.

Returns:

The time policy.

milliseconds

public static Time milliseconds(long milliseconds)

Creates a new Time that represents the given number of milliseconds.

seconds

public static Time seconds(long seconds)

Creates a new Time that represents the given number of seconds.

minutes

public static Time minutes(long minutes)

Creates a new Time that represents the given number of minutes.

hours

public static Time hours(long hours)

Creates a new Time that represents the given number of hours.

days

public static Time days(long days)

Creates a new Time that represents the given number of days.