org.apache.beam.sdk.values

Class WindowedValues.ParamWindowedValueCoder<T>

java.lang.Object

org.apache.beam.sdk.coders.Coder<T>

org.apache.beam.sdk.coders.StructuredCoder<WindowedValue<T>>

org.apache.beam.sdk.values.WindowedValues.WindowedValueCoder<T>

org.apache.beam.sdk.values.WindowedValues.FullWindowedValueCoder<T>

org.apache.beam.sdk.values.WindowedValues.ParamWindowedValueCoder<T>

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

WindowedValues

public static class WindowedValues.ParamWindowedValueCoder<T>
extends WindowedValues.FullWindowedValueCoder<T>

A parameterized coder for WindowedValue.

A ParamWindowedValueCoder only encodes and decodes the value. It drops timestamp, windows, and pane info during encoding, and uses the supplied parameterized timestamp, windows and pane info values during decoding when reconstructing the windowed value.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
WindowedValue<T>	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
WindowedValue<T>	decode(java.io.InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(WindowedValue<T> windowedElem, java.io.OutputStream outStream) Encodes the given value of type T onto the given output stream.
void	encode(WindowedValue<T> windowedElem, java.io.OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
static WindowedValues.ParamWindowedValueCoder<?>	fromComponents(java.util.List<Coder<?>> components, byte[] payload) Create a Coder from its component coders.
PaneInfo	getPaneInfo()
static byte[]	getPayload(WindowedValues.ParamWindowedValueCoder<?> from) Returns the serialized payload that will be provided when deserializing this coder.
Instant	getTimestamp()
java.util.Collection<? extends BoundedWindow>	getWindows()
static <T> WindowedValues.ParamWindowedValueCoder<T>	of(Coder<T> valueCoder) Returns the WindowedValues.ParamWindowedValueCoder for the given valueCoder and GlobalWindow.Coder#INSTANCE using BoundedWindow.TIMESTAMP_MIN_VALUE as the timestamp, WindowedValues.GLOBAL_WINDOWS as the window and PaneInfo.NO_FIRING as the pane info for parameters.
static <T> WindowedValues.ParamWindowedValueCoder<T>	of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder) Returns the WindowedValues.ParamWindowedValueCoder for the given valueCoder and windowCoder using BoundedWindow.TIMESTAMP_MIN_VALUE as the timestamp, WindowedValues.GLOBAL_WINDOWS as the window and PaneInfo.NO_FIRING as the pane info for parameters.
static <T> WindowedValues.ParamWindowedValueCoder<T>	of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder, Instant timestamp, java.util.Collection<? extends BoundedWindow> windows, PaneInfo paneInfo) Returns the WindowedValues.ParamWindowedValueCoder for the given valueCoder and windowCoder using the supplied parameterized timestamp, windows and pane info for WindowedValues.
void	registerByteSizeObserver(WindowedValue<T> value, org.apache.beam.sdk.util.common.ElementByteSizeObserver observer) Notifies the ElementByteSizeObserver about the byte size of the encoded value using this Coder.
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.
<NewT> WindowedValues.WindowedValueCoder<NewT>	withValueCoder(Coder<NewT> valueCoder) Returns a new WindowedValueCoder that is a copy of this one, but with a different value coder.

Methods inherited from class org.apache.beam.sdk.values.WindowedValues.FullWindowedValueCoder

getCoderArguments, getComponents, getWindowCoder, getWindowsCoder

Methods inherited from class org.apache.beam.sdk.values.WindowedValues.WindowedValueCoder

getValueCoder

Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder

equals, hashCode, toString

Methods inherited from class org.apache.beam.sdk.coders.Coder

consistentWithEquals, getEncodedElementByteSize, getEncodedElementByteSizeUsingCoder, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <T> WindowedValues.ParamWindowedValueCoder<T> of(Coder<T> valueCoder,
                                                               Coder<? extends BoundedWindow> windowCoder,
                                                               Instant timestamp,
                                                               java.util.Collection<? extends BoundedWindow> windows,
                                                               PaneInfo paneInfo)

Returns the WindowedValues.ParamWindowedValueCoder for the given valueCoder and windowCoder using the supplied parameterized timestamp, windows and pane info for WindowedValues.

of

public static <T> WindowedValues.ParamWindowedValueCoder<T> of(Coder<T> valueCoder,
                                                               Coder<? extends BoundedWindow> windowCoder)

Returns the WindowedValues.ParamWindowedValueCoder for the given valueCoder and windowCoder using BoundedWindow.TIMESTAMP_MIN_VALUE as the timestamp, WindowedValues.GLOBAL_WINDOWS as the window and PaneInfo.NO_FIRING as the pane info for parameters.

of

public static <T> WindowedValues.ParamWindowedValueCoder<T> of(Coder<T> valueCoder)

Returns the WindowedValues.ParamWindowedValueCoder for the given valueCoder and GlobalWindow.Coder#INSTANCE using BoundedWindow.TIMESTAMP_MIN_VALUE as the timestamp, WindowedValues.GLOBAL_WINDOWS as the window and PaneInfo.NO_FIRING as the pane info for parameters.

withValueCoder

public <NewT> WindowedValues.WindowedValueCoder<NewT> withValueCoder(Coder<NewT> valueCoder)

Description copied from class: WindowedValues.WindowedValueCoder

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

Overrides:

withValueCoder in class WindowedValues.FullWindowedValueCoder<T>

encode

public void encode(WindowedValue<T> windowedElem,
                   java.io.OutputStream outStream)
            throws CoderException,
                   java.io.IOException

Description copied from class: Coder

Encodes the given value of type T onto the given output stream. Multiple elements can be encoded next to each other on the output stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.

Overrides:

encode in class WindowedValues.FullWindowedValueCoder<T>

Throws:

CoderException - if the value could not be encoded for some reason

java.io.IOException - if writing to the OutputStream fails for some reason

encode

public void encode(WindowedValue<T> windowedElem,
                   java.io.OutputStream outStream,
                   Coder.Context context)
            throws CoderException,
                   java.io.IOException

Description copied from class: Coder

Encodes the given value of type T onto the given output stream in the given context.

Overrides:

encode in class WindowedValues.FullWindowedValueCoder<T>

Throws:

CoderException - if the value could not be encoded for some reason

java.io.IOException - if writing to the OutputStream fails for some reason

decode

public WindowedValue<T> decode(java.io.InputStream inStream)
                        throws CoderException,
                               java.io.IOException

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value. Multiple elements can be encoded next to each other on the input stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.

Overrides:

decode in class WindowedValues.FullWindowedValueCoder<T>

Throws:

CoderException - if the value could not be decoded for some reason

java.io.IOException - if reading from the InputStream fails for some reason

decode

public WindowedValue<T> decode(java.io.InputStream inStream,
                               Coder.Context context)
                        throws CoderException,
                               java.io.IOException

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Overrides:

decode in class WindowedValues.FullWindowedValueCoder<T>

Throws:

CoderException - if the value could not be decoded for some reason

java.io.IOException - if reading from the InputStream fails for some reason

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

Description copied from class: Coder

Throw Coder.NonDeterministicException if the coding is not deterministic.

In order for a Coder to be considered deterministic, the following must be true:

• two values that compare as equal (via Object.equals() or Comparable.compareTo(), if supported) have the same encoding.
• the Coder always produces a canonical encoding, which is the same for an instance of an object even if produced on different computers at different times.

Overrides:

verifyDeterministic in class WindowedValues.FullWindowedValueCoder<T>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

registerByteSizeObserver

public void registerByteSizeObserver(WindowedValue<T> value,
                                     org.apache.beam.sdk.util.common.ElementByteSizeObserver observer)
                              throws java.lang.Exception

Description copied from class: Coder

Notifies the ElementByteSizeObserver about the byte size of the encoded value using this Coder.

Not intended to be called by user code, but instead by PipelineRunner implementations.

By default, this notifies observer about the byte size of the encoded value using this coder as returned by Coder.getEncodedElementByteSize(T).

Overrides:

registerByteSizeObserver in class WindowedValues.FullWindowedValueCoder<T>

Throws:

java.lang.Exception

getTimestamp

public Instant getTimestamp()

getWindows

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

getPaneInfo

public PaneInfo getPaneInfo()

getPayload

public static byte[] getPayload(WindowedValues.ParamWindowedValueCoder<?> from)

Returns the serialized payload that will be provided when deserializing this coder.

fromComponents

public static WindowedValues.ParamWindowedValueCoder<?> fromComponents(java.util.List<Coder<?>> components,
                                                                       byte[] payload)

Create a Coder from its component coders.