org.apache.beam.sdk.values

Class WindowingStrategy<T,W extends BoundedWindow>

java.lang.Object

org.apache.beam.sdk.values.WindowingStrategy<T,W>

Type Parameters:

T - type of elements being windowed

W - BoundedWindow subclass used to represent the windows used by this WindowingStrategy

All Implemented Interfaces:

java.io.Serializable

@Internal
public class WindowingStrategy<T,W extends BoundedWindow>
extends java.lang.Object
implements java.io.Serializable

A WindowingStrategy describes the windowing behavior for a specific collection of values. It has both a WindowFn describing how elements are assigned to windows and a Trigger that controls when output is produced for each window.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WindowingStrategy.AccumulationMode The accumulation modes that can be used with windowing.

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable java.lang.Object object)
WindowingStrategy<T,W>	fixDefaults() Fixes all the defaults so that equals can be used to check that two strategies are the same, regardless of the state of "defaulted-ness".
Duration	getAllowedLateness()
Window.ClosingBehavior	getClosingBehavior()
java.lang.String	getEnvironmentId()
WindowingStrategy.AccumulationMode	getMode()
Window.OnTimeBehavior	getOnTimeBehavior()
TimestampCombiner	getTimestampCombiner()
Trigger	getTrigger()
WindowFn<T,W>	getWindowFn()
static WindowingStrategy<java.lang.Object,GlobalWindow>	globalDefault() Return a fully specified, default windowing strategy.
int	hashCode()
boolean	isAllowedLatenessSpecified()
boolean	isAlreadyMerged()
boolean	isModeSpecified()
boolean	isTimestampCombinerSpecified()
boolean	isTriggerSpecified()
boolean	needsMerge()
static <T,W extends BoundedWindow> WindowingStrategy<T,W>	of(WindowFn<T,W> windowFn)
java.lang.String	toString()
WindowingStrategy<T,W>	withAllowedLateness(Duration allowedLateness) Returns a WindowingStrategy identical to this but with the allowed lateness set to allowedLateness.
WindowingStrategy<T,W>	withAlreadyMerged(boolean alreadyMerged)
WindowingStrategy<T,W>	withClosingBehavior(Window.ClosingBehavior closingBehavior)
WindowingStrategy<T,W>	withEnvironmentId(java.lang.String environmentId)
WindowingStrategy<T,W>	withMode(WindowingStrategy.AccumulationMode mode) Returns a WindowingStrategy identical to this but with the accumulation mode set to mode.
WindowingStrategy<T,W>	withOnTimeBehavior(Window.OnTimeBehavior onTimeBehavior)
WindowingStrategy<T,W>	withTimestampCombiner(TimestampCombiner timestampCombiner)
WindowingStrategy<T,W>	withTrigger(Trigger trigger) Returns a WindowingStrategy identical to this but with the trigger set to wildcardTrigger.
WindowingStrategy<T,W>	withWindowFn(WindowFn<?,?> wildcardWindowFn) Returns a WindowingStrategy identical to this but with the window function set to wildcardWindowFn.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

globalDefault

public static WindowingStrategy<java.lang.Object,GlobalWindow> globalDefault()

Return a fully specified, default windowing strategy.

of

public static <T,W extends BoundedWindow> WindowingStrategy<T,W> of(WindowFn<T,W> windowFn)

getWindowFn

public WindowFn<T,W> getWindowFn()

getTrigger

public Trigger getTrigger()

isTriggerSpecified

public boolean isTriggerSpecified()

getAllowedLateness

public Duration getAllowedLateness()

isAllowedLatenessSpecified

public boolean isAllowedLatenessSpecified()

getMode

public WindowingStrategy.AccumulationMode getMode()

isModeSpecified

public boolean isModeSpecified()

isAlreadyMerged

public boolean isAlreadyMerged()

needsMerge

public boolean needsMerge()

getClosingBehavior

public Window.ClosingBehavior getClosingBehavior()

getOnTimeBehavior

public Window.OnTimeBehavior getOnTimeBehavior()

getTimestampCombiner

public TimestampCombiner getTimestampCombiner()

isTimestampCombinerSpecified

public boolean isTimestampCombinerSpecified()

getEnvironmentId

public java.lang.String getEnvironmentId()

withTrigger

public WindowingStrategy<T,W> withTrigger(Trigger trigger)

Returns a WindowingStrategy identical to this but with the trigger set to wildcardTrigger.

withMode

public WindowingStrategy<T,W> withMode(WindowingStrategy.AccumulationMode mode)

Returns a WindowingStrategy identical to this but with the accumulation mode set to mode.

withWindowFn

public WindowingStrategy<T,W> withWindowFn(WindowFn<?,?> wildcardWindowFn)

Returns a WindowingStrategy identical to this but with the window function set to wildcardWindowFn.

withAllowedLateness

public WindowingStrategy<T,W> withAllowedLateness(Duration allowedLateness)

Returns a WindowingStrategy identical to this but with the allowed lateness set to allowedLateness.

withClosingBehavior

public WindowingStrategy<T,W> withClosingBehavior(Window.ClosingBehavior closingBehavior)

withOnTimeBehavior

public WindowingStrategy<T,W> withOnTimeBehavior(Window.OnTimeBehavior onTimeBehavior)

withTimestampCombiner

@Experimental(value=OUTPUT_TIME)
public WindowingStrategy<T,W> withTimestampCombiner(TimestampCombiner timestampCombiner)

withEnvironmentId

public WindowingStrategy<T,W> withEnvironmentId(java.lang.String environmentId)

withAlreadyMerged

public WindowingStrategy<T,W> withAlreadyMerged(boolean alreadyMerged)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(@Nullable java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fixDefaults

public WindowingStrategy<T,W> fixDefaults()

Fixes all the defaults so that equals can be used to check that two strategies are the same, regardless of the state of "defaulted-ness".