Package org.apache.beam.sdk.util
Class WindowedValue.FullWindowedValueCoder<T>
- java.lang.Object
-
- org.apache.beam.sdk.coders.Coder<T>
-
- org.apache.beam.sdk.coders.StructuredCoder<WindowedValue<T>>
-
- org.apache.beam.sdk.util.WindowedValue.WindowedValueCoder<T>
-
- org.apache.beam.sdk.util.WindowedValue.FullWindowedValueCoder<T>
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
WindowedValue.ParamWindowedValueCoder
- Enclosing class:
- WindowedValue<T>
public static class WindowedValue.FullWindowedValueCoder<T> extends WindowedValue.WindowedValueCoder<T>
Coder forWindowedValue
.- 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description WindowedValue<T>
decode(java.io.InputStream inStream)
Decodes a value of typeT
from the given input stream in the given context.WindowedValue<T>
decode(java.io.InputStream inStream, Coder.Context context)
Decodes a value of typeT
from the given input stream in the given context.void
encode(WindowedValue<T> windowedElem, java.io.OutputStream outStream)
Encodes the given value of typeT
onto the given output stream.void
encode(WindowedValue<T> windowedElem, java.io.OutputStream outStream, Coder.Context context)
Encodes the given value of typeT
onto the given output stream in the given context.java.util.List<? extends Coder<?>>
getCoderArguments()
java.util.List<? extends Coder<?>>
getComponents()
Coder<? extends BoundedWindow>
getWindowCoder()
Coder<java.util.Collection<? extends BoundedWindow>>
getWindowsCoder()
static <T> WindowedValue.FullWindowedValueCoder<T>
of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder)
void
registerByteSizeObserver(WindowedValue<T> value, ElementByteSizeObserver observer)
Notifies theElementByteSizeObserver
about the byte size of the encoded value using thisCoder
.void
verifyDeterministic()
ThrowCoder.NonDeterministicException
if the coding is not deterministic.<NewT> WindowedValue.WindowedValueCoder<NewT>
withValueCoder(Coder<NewT> valueCoder)
Returns a newWindowedValueCoder
that is a copy of this one, but with a different value coder.-
Methods inherited from class org.apache.beam.sdk.util.WindowedValue.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, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, structuralValue, verifyDeterministic, verifyDeterministic
-
-
-
-
Method Detail
-
of
public static <T> WindowedValue.FullWindowedValueCoder<T> of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder)
-
getWindowCoder
public Coder<? extends BoundedWindow> getWindowCoder()
-
getWindowsCoder
public Coder<java.util.Collection<? extends BoundedWindow>> getWindowsCoder()
-
withValueCoder
public <NewT> WindowedValue.WindowedValueCoder<NewT> withValueCoder(Coder<NewT> valueCoder)
Description copied from class:WindowedValue.WindowedValueCoder
Returns a newWindowedValueCoder
that is a copy of this one, but with a different value coder.- Specified by:
withValueCoder
in classWindowedValue.WindowedValueCoder<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 typeT
onto the given output stream.- Specified by:
encode
in classCoder<WindowedValue<T>>
- Throws:
CoderException
- if the value could not be encoded for some reasonjava.io.IOException
- if writing to theOutputStream
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 typeT
onto the given output stream in the given context.- Overrides:
encode
in classCoder<WindowedValue<T>>
- Throws:
CoderException
- if the value could not be encoded for some reasonjava.io.IOException
- if writing to theOutputStream
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 typeT
from the given input stream in the given context. Returns the decoded value.- Specified by:
decode
in classCoder<WindowedValue<T>>
- Throws:
CoderException
- if the value could not be decoded for some reasonjava.io.IOException
- if reading from theInputStream
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 typeT
from the given input stream in the given context. Returns the decoded value.- Overrides:
decode
in classCoder<WindowedValue<T>>
- Throws:
CoderException
- if the value could not be decoded for some reasonjava.io.IOException
- if reading from theInputStream
fails for some reason
-
verifyDeterministic
public void verifyDeterministic() throws Coder.NonDeterministicException
Description copied from class:Coder
ThrowCoder.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()
orComparable.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 classCoder<WindowedValue<T>>
- Throws:
Coder.NonDeterministicException
- if this coder is not deterministic.
- two values that compare as equal (via
-
registerByteSizeObserver
public void registerByteSizeObserver(WindowedValue<T> value, ElementByteSizeObserver observer) throws java.lang.Exception
Description copied from class:Coder
Notifies theElementByteSizeObserver
about the byte size of the encoded value using thisCoder
.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 byCoder.getEncodedElementByteSize(T)
.- Overrides:
registerByteSizeObserver
in classCoder<WindowedValue<T>>
- Throws:
java.lang.Exception
-
getCoderArguments
public java.util.List<? extends Coder<?>> getCoderArguments()
If this is aCoder
for a parameterized type, returns the list ofCoder
s 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 thisCoder
does not encode/decode a parameterized type, returns the empty list..- Specified by:
getCoderArguments
in classCoder<WindowedValue<T>>
- Returns:
- a singleton list containing the
valueCoder
of thisWindowedValue.FullWindowedValueCoder
.
-
getComponents
public java.util.List<? extends Coder<?>> getComponents()
Description copied from class:StructuredCoder
Returns the list ofCoders
that are components of thisCoder
.The default components will be equal to the value returned by
Coder.getCoderArguments()
.- Overrides:
getComponents
in classStructuredCoder<WindowedValue<T>>
-
-