org.apache.flink.streaming.api.windowing.assigners

Class GlobalWindows

java.lang.Object

org.apache.flink.streaming.api.windowing.assigners.WindowAssigner<Object,GlobalWindow>

org.apache.flink.streaming.api.windowing.assigners.GlobalWindows

All Implemented Interfaces:

Serializable

@PublicEvolving
public class GlobalWindows
extends WindowAssigner<Object,GlobalWindow>

A WindowAssigner that assigns all elements to the same GlobalWindow.

Use this if you want to use a Trigger and Evictor to do flexible, policy based windows.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalWindows.EndOfStreamTrigger A trigger that fires iff the input stream reaches EndOfStream.
static class	GlobalWindows.NeverTrigger A trigger that never fires, as default Trigger for GlobalWindows.

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.windowing.assigners.WindowAssigner

WindowAssigner.WindowAssignerContext

Method Summary

Modifier and Type	Method and Description
Collection<GlobalWindow>	assignWindows(Object element, long timestamp, WindowAssigner.WindowAssignerContext context) Returns a Collection of windows that should be assigned to the element.
static GlobalWindows	create() Creates a WindowAssigner that assigns all elements to the same GlobalWindow.
static GlobalWindows	createWithEndOfStreamTrigger() Creates a WindowAssigner that assigns all elements to the same GlobalWindow and the window is triggered if and only if the input stream is ended.
Trigger<Object,GlobalWindow>	getDefaultTrigger() Returns the default trigger associated with this WindowAssigner.
Trigger<Object,GlobalWindow>	getDefaultTrigger(StreamExecutionEnvironment env) Returns the default trigger associated with this WindowAssigner.
TypeSerializer<GlobalWindow>	getWindowSerializer(ExecutionConfig executionConfig) Returns a TypeSerializer for serializing windows that are assigned by this WindowAssigner.
boolean	isEventTime() Returns true if elements are assigned to windows based on event time, false otherwise.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

assignWindows

public Collection<GlobalWindow> assignWindows(Object element,
                                              long timestamp,
                                              WindowAssigner.WindowAssignerContext context)

Description copied from class: WindowAssigner

Returns a Collection of windows that should be assigned to the element.

Specified by:

assignWindows in class WindowAssigner<Object,GlobalWindow>

Parameters:

element - The element to which windows should be assigned.

timestamp - The timestamp of the element.

context - The WindowAssigner.WindowAssignerContext in which the assigner operates.

getDefaultTrigger

public Trigger<Object,GlobalWindow> getDefaultTrigger(StreamExecutionEnvironment env)

Description copied from class: WindowAssigner

Returns the default trigger associated with this WindowAssigner.

Specified by:

getDefaultTrigger in class WindowAssigner<Object,GlobalWindow>

See Also:

FLIP-343: Remove parameter in WindowAssigner#getDefaultTrigger()

getDefaultTrigger

public Trigger<Object,GlobalWindow> getDefaultTrigger()

Description copied from class: WindowAssigner

Returns the default trigger associated with this WindowAssigner.

1. If you override getDefaultTrigger(), the getDefaultTrigger() will be invoked and the getDefaultTrigger(StreamExecutionEnvironment env) won't be invoked. 2. If you don't override getDefaultTrigger(), the getDefaultTrigger(StreamExecutionEnvironment env) will be invoked in the default implementation of the getDefaultTrigger().

Overrides:

getDefaultTrigger in class WindowAssigner<Object,GlobalWindow>

toString

public String toString()

Overrides:

toString in class Object

create

public static GlobalWindows create()

Creates a WindowAssigner that assigns all elements to the same GlobalWindow. The window is only useful if you also specify a custom trigger. Otherwise, the window will never be triggered and no computation will be performed.

createWithEndOfStreamTrigger

public static GlobalWindows createWithEndOfStreamTrigger()

Creates a WindowAssigner that assigns all elements to the same GlobalWindow and the window is triggered if and only if the input stream is ended.

getWindowSerializer

public TypeSerializer<GlobalWindow> getWindowSerializer(ExecutionConfig executionConfig)

Description copied from class: WindowAssigner

Returns a TypeSerializer for serializing windows that are assigned by this WindowAssigner.

Specified by:

getWindowSerializer in class WindowAssigner<Object,GlobalWindow>

isEventTime

public boolean isEventTime()

Description copied from class: WindowAssigner

Returns true if elements are assigned to windows based on event time, false otherwise.

Specified by:

isEventTime in class WindowAssigner<Object,GlobalWindow>