com.google.cloud.dataflow.sdk.util

Class WindowedValue.ValueOnlyWindowedValueCoder<T>

java.lang.Object

com.google.cloud.dataflow.sdk.coders.StandardCoder<WindowedValue<T>>

com.google.cloud.dataflow.sdk.util.WindowedValue.WindowedValueCoder<T>

com.google.cloud.dataflow.sdk.util.WindowedValue.ValueOnlyWindowedValueCoder<T>

All Implemented Interfaces:

Coder<WindowedValue<T>>, Serializable

Enclosing class:

WindowedValue<V>

public static class WindowedValue.ValueOnlyWindowedValueCoder<T>
extends WindowedValue.WindowedValueCoder<T>

Coder for WindowedValue.

A ValueOnlyWindowedValueCoder only encodes and decodes the value. It drops timestamp and windows for encoding, and uses defaults timestamp, and windows for decoding.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
CloudObject	asCloudObject() Returns the CloudObject that represents this Coder.
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, 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, or returns null if this cannot be done or this is not a parameterized type.
static <T> WindowedValue.ValueOnlyWindowedValueCoder<T>	of(Coder<T> valueCoder)
static WindowedValue.ValueOnlyWindowedValueCoder<?>	of(List<Coder<?>> components)
void	registerByteSizeObserver(WindowedValue<T> value, ElementByteSizeObserver observer, Coder.Context context) Notifies ElementByteSizeObserver about the byte size of the encoded value using this coder.
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.
<V> WindowedValue.WindowedValueCoder<V>	withValueCoder(Coder<V> valueCoder) Returns a new WindowedValueCoder that is a copy of this one, but with a different value coder.

Methods inherited from class com.google.cloud.dataflow.sdk.util.WindowedValue.WindowedValueCoder

getValueCoder

Methods inherited from class com.google.cloud.dataflow.sdk.coders.StandardCoder

consistentWithEquals, equals, getAllowedEncodings, getComponents, getEncodedElementByteSize, getEncodingId, hashCode, isRegisterByteSizeObserverCheap, structuralValue, toString, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

of

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

of

public static WindowedValue.ValueOnlyWindowedValueCoder<?> of(List<Coder<?>> components)

withValueCoder

public <V> WindowedValue.WindowedValueCoder<V> withValueCoder(Coder<V> valueCoder)

Description copied from class: WindowedValue.WindowedValueCoder

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

Specified by:

withValueCoder in class WindowedValue.WindowedValueCoder<T>

encode

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

Description copied from interface: Coder

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

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,
                               Coder.Context context)
                        throws CoderException,
                               IOException

Description copied from interface: Coder

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

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 interface: 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.

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

registerByteSizeObserver

public void registerByteSizeObserver(WindowedValue<T> value,
                                     ElementByteSizeObserver observer,
                                     Coder.Context context)
                              throws Exception

Description copied from class: StandardCoder

Notifies ElementByteSizeObserver about the byte size of the encoded value using this coder. Calls getEncodedElementByteSize() and notifies ElementByteSizeObserver.

Specified by:

registerByteSizeObserver in interface Coder<WindowedValue<T>>

Overrides:

registerByteSizeObserver in class StandardCoder<WindowedValue<T>>

Throws:

Exception

asCloudObject

public CloudObject asCloudObject()

Description copied from interface: Coder

Returns the CloudObject that represents this Coder.

Specified by:

asCloudObject in interface Coder<WindowedValue<T>>

Overrides:

asCloudObject in class StandardCoder<WindowedValue<T>>

getCoderArguments

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

Description copied from interface: Coder

If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters, or returns null if this cannot be done or this is not a parameterized type.