org.apache.beam.sdk.transforms.windowing

Class InvalidWindows<W extends BoundedWindow>

java.lang.Object

org.apache.beam.sdk.transforms.windowing.WindowFn<java.lang.Object,W>

org.apache.beam.sdk.transforms.windowing.InvalidWindows<W>

Type Parameters:

W - window type

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

public class InvalidWindows<W extends BoundedWindow>
extends WindowFn<java.lang.Object,W>

A WindowFn that represents an invalid pipeline state.

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
InvalidWindows(java.lang.String cause, WindowFn<?,W> originalWindowFn)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<W>	assignWindows(WindowFn.AssignContext c) Given a timestamp and element, returns the set of windows into which it should be placed.
java.lang.String	getCause() Returns the reason that this WindowFn is invalid.
WindowMappingFn<W>	getDefaultWindowMappingFn() Returns the default WindowMappingFn to use to map main input windows to side input windows.
WindowFn<?,W>	getOriginalWindowFn() Returns the original windowFn that this InvalidWindows replaced.
Instant	getOutputTime(Instant inputTimestamp, W window) Returns the output timestamp to use for data depending on the given inputTimestamp in the specified window.
boolean	isCompatible(WindowFn<?,?> other) InvalidWindows objects with the same originalWindowFn are compatible.
void	mergeWindows(WindowFn.MergeContext c) Does whatever merging of windows is necessary.
void	verifyCompatibility(WindowFn<?,?> other) Throw IncompatibleWindowException if this WindowFn does not perform the same merging as the given $WindowFn.
Coder<W>	windowCoder() Returns the Coder used for serializing the windows used by this windowFn.

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

assignsToOneWindow, getWindowTypeDescriptor, isNonMerging, populateDisplayData

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidWindows

public InvalidWindows(java.lang.String cause,
                      WindowFn<?,W> originalWindowFn)

Method Detail

getCause

public java.lang.String getCause()

Returns the reason that this WindowFn is invalid.

getOriginalWindowFn

public WindowFn<?,W> getOriginalWindowFn()

Returns the original windowFn that this InvalidWindows replaced.

assignWindows

public java.util.Collection<W> 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<java.lang.Object,W extends BoundedWindow>

mergeWindows

public void mergeWindows(WindowFn.MergeContext c)

Description copied from class: WindowFn

Does whatever merging of windows is necessary.

See MergeOverlappingIntervalWindows.mergeWindows(org.apache.beam.sdk.transforms.windowing.WindowFn<?, org.apache.beam.sdk.transforms.windowing.IntervalWindow>.MergeContext) for an example of how to override this method.

Specified by:

mergeWindows in class WindowFn<java.lang.Object,W extends BoundedWindow>

windowCoder

public Coder<W> windowCoder()

Description copied from class: WindowFn

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

Specified by:

windowCoder in class WindowFn<java.lang.Object,W extends BoundedWindow>

isCompatible

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

InvalidWindows objects with the same originalWindowFn are compatible.

Specified by:

isCompatible in class WindowFn<java.lang.Object,W extends BoundedWindow>

verifyCompatibility

public void verifyCompatibility(WindowFn<?,?> other)
                         throws IncompatibleWindowException

Description copied from class: WindowFn

Throw IncompatibleWindowException if this WindowFn does not perform the same merging as the given $WindowFn.

Overrides:

verifyCompatibility in class WindowFn<java.lang.Object,W extends BoundedWindow>

Throws:

IncompatibleWindowException - if compared WindowFns are not compatible.

getDefaultWindowMappingFn

public WindowMappingFn<W> getDefaultWindowMappingFn()

Description copied from class: WindowFn

Returns the default WindowMappingFn to use to map main input windows to side input windows. This should accept arbitrary main input windows, and produce a BoundedWindow that can be produced by this WindowFn.

Specified by:

getDefaultWindowMappingFn in class WindowFn<java.lang.Object,W extends BoundedWindow>

getOutputTime

public Instant getOutputTime(Instant inputTimestamp,
                             W 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<java.lang.Object,W extends BoundedWindow>