Package org.apache.beam.sdk.util

Class WindowedValue<T>

java.lang.Object

org.apache.beam.sdk.util.WindowedValue<T>

Type Parameters:

T - the type of the value

@Internal
public abstract class WindowedValue<T>
extends java.lang.Object

An immutable triple of value, timestamp, and windows.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WindowedValue.FullWindowedValueCoder<T>	Coder for WindowedValue.
static class	WindowedValue.ParamWindowedValueCoder<T>	A parameterized coder for WindowedValue.
static interface	WindowedValue.SingleWindowedValue	A WindowedValue which holds exactly single window per value.
static class	WindowedValue.ValueOnlyWindowedValueCoder<T>	Deprecated. Use ParamWindowedValueCoder instead, it is a general purpose implementation of the same concept but makes timestamp, windows and pane info configurable.
static class	WindowedValue.WindowedValueCoder<T>	Abstract class for WindowedValue coder.

Constructor Summary

Constructors

Constructor	Description
WindowedValue()

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable java.lang.Object other)
java.lang.Iterable<WindowedValue<T>>	explodeWindows()	Returns a collection of WindowedValues identical to this one, except each is in exactly one of the windows that this WindowedValue is in.
static <T> WindowedValue.FullWindowedValueCoder<T>	getFullCoder(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder)	Returns the Coder to use for a WindowedValue<T>, using the given valueCoder and windowCoder.
abstract PaneInfo	getPane()	Returns the pane of this WindowedValue in its window.
static <T> WindowedValue.ParamWindowedValueCoder<T>	getParamWindowedValueCoder(Coder<T> valueCoder)	Returns the ParamWindowedValueCoder from the given valueCoder.
abstract org.joda.time.Instant	getTimestamp()	Returns the timestamp of this WindowedValue.
abstract T	getValue()	Returns the value of this WindowedValue.
static <T> WindowedValue.ValueOnlyWindowedValueCoder<T>	getValueOnlyCoder(Coder<T> valueCoder)	Returns the ValueOnlyCoder from the given valueCoder.
abstract java.util.Collection<? extends BoundedWindow>	getWindows()	Returns the windows of this WindowedValue.
int	hashCode()
boolean	isSingleWindowedValue()	Returns true if this WindowedValue has exactly one window.
static <T> WindowedValue<T>	of(T value, org.joda.time.Instant timestamp, java.util.Collection<? extends BoundedWindow> windows, PaneInfo pane)	Returns a WindowedValue with the given value, timestamp, and windows.
static <T> WindowedValue<T>	of(T value, org.joda.time.Instant timestamp, BoundedWindow window, PaneInfo pane)	Returns a WindowedValue with the given value, timestamp, and window.
static <T> WindowedValue<T>	timestampedValueInGlobalWindow(T value, org.joda.time.Instant timestamp)	Returns a WindowedValue with the given value and timestamp, GlobalWindow and default pane.
static <T> WindowedValue<T>	timestampedValueInGlobalWindow(T value, org.joda.time.Instant timestamp, PaneInfo paneInfo)	Returns a WindowedValue with the given value, timestamp, and pane in the GlobalWindow.
abstract java.lang.String	toString()
static <T> WindowedValue<T>	valueInGlobalWindow(T value)	Returns a WindowedValue with the given value in the GlobalWindow using the default timestamp and pane.
static <T> WindowedValue<T>	valueInGlobalWindow(T value, PaneInfo pane)	Returns a WindowedValue with the given value in the GlobalWindow using the default timestamp and the specified pane.
abstract <NewT> WindowedValue<NewT>	withValue(NewT value)	Returns a new WindowedValue that is a copy of this one, but with a different value, which may have a new type NewT.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowedValue

public WindowedValue()

Method Detail

of

public static <T> WindowedValue<T> of(T value,
                                      org.joda.time.Instant timestamp,
                                      java.util.Collection<? extends BoundedWindow> windows,
                                      PaneInfo pane)

Returns a WindowedValue with the given value, timestamp, and windows.

of

public static <T> WindowedValue<T> of(T value,
                                      org.joda.time.Instant timestamp,
                                      BoundedWindow window,
                                      PaneInfo pane)

Returns a WindowedValue with the given value, timestamp, and window.

valueInGlobalWindow

public static <T> WindowedValue<T> valueInGlobalWindow(T value)

Returns a WindowedValue with the given value in the GlobalWindow using the default timestamp and pane.

valueInGlobalWindow

public static <T> WindowedValue<T> valueInGlobalWindow(T value,
                                                       PaneInfo pane)

Returns a WindowedValue with the given value in the GlobalWindow using the default timestamp and the specified pane.

timestampedValueInGlobalWindow

public static <T> WindowedValue<T> timestampedValueInGlobalWindow(T value,
                                                                  org.joda.time.Instant timestamp)

Returns a WindowedValue with the given value and timestamp, GlobalWindow and default pane.

timestampedValueInGlobalWindow

public static <T> WindowedValue<T> timestampedValueInGlobalWindow(T value,
                                                                  org.joda.time.Instant timestamp,
                                                                  PaneInfo paneInfo)

Returns a WindowedValue with the given value, timestamp, and pane in the GlobalWindow.

withValue

public abstract <NewT> WindowedValue<NewT> withValue(NewT value)

Returns a new WindowedValue that is a copy of this one, but with a different value, which may have a new type NewT.

getValue

public abstract T getValue()

Returns the value of this WindowedValue.

getTimestamp

public abstract org.joda.time.Instant getTimestamp()

Returns the timestamp of this WindowedValue.

getWindows

public abstract java.util.Collection<? extends BoundedWindow> getWindows()

Returns the windows of this WindowedValue.

getPane

public abstract PaneInfo getPane()

Returns the pane of this WindowedValue in its window.

isSingleWindowedValue

public boolean isSingleWindowedValue()

Returns true if this WindowedValue has exactly one window.

explodeWindows

public java.lang.Iterable<WindowedValue<T>> explodeWindows()

Returns a collection of WindowedValues identical to this one, except each is in exactly one of the windows that this WindowedValue is in.

equals

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

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFullCoder

public static <T> WindowedValue.FullWindowedValueCoder<T> getFullCoder(Coder<T> valueCoder,
                                                                       Coder<? extends BoundedWindow> windowCoder)

Returns the Coder to use for a WindowedValue<T>, using the given valueCoder and windowCoder.

getValueOnlyCoder

public static <T> WindowedValue.ValueOnlyWindowedValueCoder<T> getValueOnlyCoder(Coder<T> valueCoder)

Returns the ValueOnlyCoder from the given valueCoder.

getParamWindowedValueCoder

public static <T> WindowedValue.ParamWindowedValueCoder<T> getParamWindowedValueCoder(Coder<T> valueCoder)

Returns the ParamWindowedValueCoder from the given valueCoder.