Package org.apache.beam.sdk.values

Class WindowedValues.FullWindowedValueCoder<T>

java.lang.Object

org.apache.beam.sdk.coders.Coder<WindowedValue<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>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

WindowedValues.ParamWindowedValueCoder

Enclosing class:

WindowedValues

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

Coder for WindowedValue.

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	Description
WindowedValue<T>	decode(InputStream inStream)	Decodes a value of type T from the given input stream in the given context.
WindowedValue<T>	decode(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, OutputStream outStream)	Encodes the given value of type T onto the given output stream.
void	encode(WindowedValue<T> windowedElem, OutputStream outStream, Coder.Context context)	Encodes the given value of type T onto the given output stream in the given context.
List<? extends Coder<?>>	getCoderArguments()	If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature.
List<? extends Coder<?>>	getComponents()	Returns the list of Coders that are components of this Coder.
Coder<? extends BoundedWindow>	getWindowCoder()
Coder<Collection<? extends BoundedWindow>>	getWindowsCoder()
static <T> WindowedValues.FullWindowedValueCoder<T>	of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder)
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.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 Details

of

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

getWindowCoder

public Coder<? extends BoundedWindow> getWindowCoder()

getWindowsCoder

public Coder<Collection<? extends BoundedWindow>> getWindowsCoder()

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.

Specified by:

withValueCoder in class WindowedValues.WindowedValueCoder<T>

encode

public void encode(WindowedValue<T> windowedElem,
 OutputStream outStream)
            throws CoderException,
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.

Specified by:

encode in class Coder<WindowedValue<T>>

Throws:

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

IOException - if writing to the OutputStream fails for some reason

encode

public void encode(WindowedValue<T> windowedElem,
 OutputStream outStream,
 Coder.Context context)
            throws CoderException,
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 Coder<WindowedValue<T>>

Throws:

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

IOException - if writing to the OutputStream fails for some reason

decode

public WindowedValue<T> decode(InputStream inStream)
                        throws CoderException,
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.

Specified by:

decode in class Coder<WindowedValue<T>>

Throws:

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

IOException - if reading from the InputStream fails for some reason

decode

public WindowedValue<T> decode(InputStream inStream,
 Coder.Context context)
                        throws CoderException,
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 Coder<WindowedValue<T>>

Throws:

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

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.

Specified by:

verifyDeterministic in class Coder<WindowedValue<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 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 Coder<WindowedValue<T>>

Throws:

Exception

getCoderArguments

public List<? extends Coder<?>> getCoderArguments()

If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature. If this cannot be done, or this Coder does not encode/decode a parameterized type, returns the empty list..

Specified by:

getCoderArguments in class Coder<WindowedValue<T>>

Returns:

a singleton list containing the valueCoder of this WindowedValues.FullWindowedValueCoder.

getComponents

public List<? extends Coder<?>> getComponents()

Description copied from class: StructuredCoder

Returns the list of Coders that are components of this Coder.

The default components will be equal to the value returned by Coder.getCoderArguments().

Overrides:

getComponents in class StructuredCoder<WindowedValue<T>>