org.apache.beam.sdk.transforms.windowing

Class GlobalWindows

java.lang.Object

org.apache.beam.sdk.transforms.windowing.WindowFn<T,W>

org.apache.beam.sdk.transforms.windowing.NonMergingWindowFn<Object,GlobalWindow>

org.apache.beam.sdk.transforms.windowing.GlobalWindows

All Implemented Interfaces:

Serializable, HasDisplayData

public class GlobalWindows
extends NonMergingWindowFn<Object,GlobalWindow>

Default WindowFn that assigns all data to the same window.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.transforms.windowing.WindowFn

WindowFn.AssignContext, WindowFn.MergeContext

Constructor Summary

Constructors

Constructor and Description
GlobalWindows()

Method Summary

Modifier and Type	Method and Description
Collection<GlobalWindow>	assignWindows(WindowFn.AssignContext c) Given a timestamp and element, returns the set of windows into which it should be placed.
Instant	getOutputTime(Instant inputTimestamp, GlobalWindow window) Returns the output timestamp to use for data depending on the given inputTimestamp in the specified window.
GlobalWindow	getSideInputWindow(BoundedWindow window) Returns the window of the side input corresponding to the given window of the main input.
boolean	isCompatible(WindowFn<?,?> o) Returns whether this performs the same merging as the given WindowFn.
Coder<GlobalWindow>	windowCoder() Returns the Coder used for serializing the windows used by this windowFn.

Methods inherited from class org.apache.beam.sdk.transforms.windowing.NonMergingWindowFn

isNonMerging, mergeWindows

Methods inherited from class org.apache.beam.sdk.transforms.windowing.WindowFn

populateDisplayData

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalWindows

public GlobalWindows()

Method Detail

assignWindows

public Collection<GlobalWindow> assignWindows(WindowFn.AssignContext c)

Description copied from class: WindowFn

Given a timestamp and element, returns the set of windows into which it should be placed.

Specified by:

assignWindows in class WindowFn<Object,GlobalWindow>

isCompatible

public boolean isCompatible(WindowFn<?,?> o)

Description copied from class: WindowFn

Returns whether this performs the same merging as the given WindowFn.

Specified by:

isCompatible in class WindowFn<Object,GlobalWindow>

windowCoder

public Coder<GlobalWindow> windowCoder()

Description copied from class: WindowFn

Returns the Coder used for serializing the windows used by this windowFn.

Specified by:

windowCoder in class WindowFn<Object,GlobalWindow>

getSideInputWindow

public GlobalWindow getSideInputWindow(BoundedWindow window)

Description copied from class: WindowFn

Returns the window of the side input corresponding to the given window of the main input.

Authors of custom WindowFns should override this.

Specified by:

getSideInputWindow in class WindowFn<Object,GlobalWindow>

getOutputTime

public Instant getOutputTime(Instant inputTimestamp,
                             GlobalWindow window)

Description copied from class: WindowFn

Returns the output timestamp to use for data depending on the given inputTimestamp in the specified window.

The result of this method must be between inputTimestamp and window.maxTimestamp() (inclusive on both sides).

This function must be monotonic across input timestamps. Specifically, if A < B, then getOutputTime(A, window) <= getOutputTime(B, window).

For a WindowFn that doesn't produce overlapping windows, this can (and typically should) just return inputTimestamp. In the presence of overlapping windows, it is suggested that the result in later overlapping windows is past the end of earlier windows so that the later windows don't prevent the watermark from progressing past the end of the earlier window.

Overrides:

getOutputTime in class WindowFn<Object,GlobalWindow>