com.google.cloud.dataflow.sdk.util

Class WindowedValue<V>

java.lang.Object

com.google.cloud.dataflow.sdk.util.WindowedValue<V>

Type Parameters:

V - the type of the value

public abstract class WindowedValue<V>
extends Object

An immutable triple of value, timestamp, and windows.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WindowedValue.FullWindowedValueCoder<T> Coder for WindowedValue.
static class	WindowedValue.ValueOnlyWindowedValueCoder<T> Coder for WindowedValue.
static class	WindowedValue.WindowedValueCoder<T> Abstract class for WindowedValue coder.

Field Summary

Fields

Modifier and Type	Field and Description
protected PaneInfo	pane
protected V	value

Method Summary

Modifier and Type	Method and Description
abstract boolean	equals(Object o)
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.
PaneInfo	getPane() Returns the pane of this WindowedValue in its window.
abstract org.joda.time.Instant	getTimestamp() Returns the timestamp of this WindowedValue.
V	getValue() Returns the value of this WindowedValue.
static <T> WindowedValue.ValueOnlyWindowedValueCoder<T>	getValueOnlyCoder(Coder<T> valueCoder) Returns the ValueOnlyCoder from the given valueCoder.
abstract Collection<? extends BoundedWindow>	getWindows() Returns the windows of this WindowedValue.
abstract int	hashCode()
static <V> WindowedValue<V>	of(V value, org.joda.time.Instant timestamp, BoundedWindow window, PaneInfo pane) Returns a WindowedValue with the given value, timestamp, and window.
static <V> WindowedValue<V>	of(V value, org.joda.time.Instant timestamp, Collection<? extends BoundedWindow> windows, PaneInfo pane) Returns a WindowedValue with the given value, timestamp, and windows.
static <V> WindowedValue<V>	timestampedValueInGlobalWindow(V value, org.joda.time.Instant timestamp) Returns a WindowedValue with the given value and timestamp, GlobalWindow and default pane.
abstract String	toString()
static <V> WindowedValue<V>	valueInEmptyWindows(V value) Returns a WindowedValue with the given value in no windows, and the default timestamp and pane.
static <V> WindowedValue<V>	valueInEmptyWindows(V value, PaneInfo pane) Returns a WindowedValue with the given value in no windows, and the default timestamp and the specified pane.
static <V> WindowedValue<V>	valueInGlobalWindow(V value) Returns a WindowedValue with the given value in the GlobalWindow using the default timestamp and pane.
static <V> WindowedValue<V>	valueInGlobalWindow(V value, PaneInfo pane) Returns a WindowedValue with the given value in the GlobalWindow using the default timestamp and the specified pane.
abstract <V> WindowedValue<V>	withValue(V value) Returns a new WindowedValue that is a copy of this one, but with a different value.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected final V value

pane

protected final PaneInfo pane

Method Detail

of

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

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

of

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

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

valueInGlobalWindow

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

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

valueInGlobalWindow

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

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

timestampedValueInGlobalWindow

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

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

valueInEmptyWindows

public static <V> WindowedValue<V> valueInEmptyWindows(V value)

Returns a WindowedValue with the given value in no windows, and the default timestamp and pane.

valueInEmptyWindows

public static <V> WindowedValue<V> valueInEmptyWindows(V value,
                                                       PaneInfo pane)

Returns a WindowedValue with the given value in no windows, and the default timestamp and the specified pane.

withValue

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

Returns a new WindowedValue that is a copy of this one, but with a different value.

getValue

public V getValue()

Returns the value of this WindowedValue.

getTimestamp

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

Returns the timestamp of this WindowedValue.

getWindows

public abstract Collection<? extends BoundedWindow> getWindows()

Returns the windows of this WindowedValue.

getPane

public PaneInfo getPane()

Returns the pane of this WindowedValue in its window.

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

toString

public abstract String toString()

Overrides:

toString in class 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.