Package org.apache.beam.sdk.util
Class WindowedValue.ParamWindowedValueCoder<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>
-
- org.apache.beam.sdk.util.WindowedValue.ParamWindowedValueCoder<T>
-
- All Implemented Interfaces:
java.io.Serializable
- Enclosing class:
- WindowedValue<T>
public static class WindowedValue.ParamWindowedValueCoder<T> extends WindowedValue.FullWindowedValueCoder<T>
A parameterized coder forWindowedValue
.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
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.static WindowedValue.ParamWindowedValueCoder<?>
fromComponents(java.util.List<Coder<?>> components, byte[] payload)
PaneInfo
getPane()
static byte[]
getPayload(WindowedValue.ParamWindowedValueCoder<?> from)
Returns the serialized payload that will be provided when deserializing this coder.org.joda.time.Instant
getTimestamp()
java.util.Collection<? extends BoundedWindow>
getWindows()
static <T> WindowedValue.ParamWindowedValueCoder<T>
of(Coder<T> valueCoder)
Returns theWindowedValue.ParamWindowedValueCoder
for the given valueCoder andGlobalWindow.Coder.INSTANCE
usingBoundedWindow.TIMESTAMP_MIN_VALUE
as the timestamp,WindowedValue.GLOBAL_WINDOWS
as the window andPaneInfo.NO_FIRING
as the pane info for parameters.static <T> WindowedValue.ParamWindowedValueCoder<T>
of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder)
Returns theWindowedValue.ParamWindowedValueCoder
for the given valueCoder and windowCoder usingBoundedWindow.TIMESTAMP_MIN_VALUE
as the timestamp,WindowedValue.GLOBAL_WINDOWS
as the window andPaneInfo.NO_FIRING
as the pane info for parameters.static <T> WindowedValue.ParamWindowedValueCoder<T>
of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder, org.joda.time.Instant timestamp, java.util.Collection<? extends BoundedWindow> windows, PaneInfo pane)
Returns theWindowedValue.ParamWindowedValueCoder
for the given valueCoder and windowCoder using the supplied parameterized timestamp, windows and pane info forWindowedValue
.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.FullWindowedValueCoder
getCoderArguments, getComponents, getWindowCoder, getWindowsCoder
-
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.ParamWindowedValueCoder<T> of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder, org.joda.time.Instant timestamp, java.util.Collection<? extends BoundedWindow> windows, PaneInfo pane)
Returns theWindowedValue.ParamWindowedValueCoder
for the given valueCoder and windowCoder using the supplied parameterized timestamp, windows and pane info forWindowedValue
.
-
of
public static <T> WindowedValue.ParamWindowedValueCoder<T> of(Coder<T> valueCoder, Coder<? extends BoundedWindow> windowCoder)
Returns theWindowedValue.ParamWindowedValueCoder
for the given valueCoder and windowCoder usingBoundedWindow.TIMESTAMP_MIN_VALUE
as the timestamp,WindowedValue.GLOBAL_WINDOWS
as the window andPaneInfo.NO_FIRING
as the pane info for parameters.
-
of
public static <T> WindowedValue.ParamWindowedValueCoder<T> of(Coder<T> valueCoder)
Returns theWindowedValue.ParamWindowedValueCoder
for the given valueCoder andGlobalWindow.Coder.INSTANCE
usingBoundedWindow.TIMESTAMP_MIN_VALUE
as the timestamp,WindowedValue.GLOBAL_WINDOWS
as the window andPaneInfo.NO_FIRING
as the pane info for parameters.
-
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.- Overrides:
withValueCoder
in classWindowedValue.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 typeT
onto the given output stream.- Overrides:
encode
in classWindowedValue.FullWindowedValueCoder<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 classWindowedValue.FullWindowedValueCoder<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.- Overrides:
decode
in classWindowedValue.FullWindowedValueCoder<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 classWindowedValue.FullWindowedValueCoder<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.
- Overrides:
verifyDeterministic
in classWindowedValue.FullWindowedValueCoder<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 classWindowedValue.FullWindowedValueCoder<T>
- Throws:
java.lang.Exception
-
getTimestamp
public org.joda.time.Instant getTimestamp()
-
getWindows
public java.util.Collection<? extends BoundedWindow> getWindows()
-
getPane
public PaneInfo getPane()
-
getPayload
public static byte[] getPayload(WindowedValue.ParamWindowedValueCoder<?> from)
Returns the serialized payload that will be provided when deserializing this coder.
-
fromComponents
public static WindowedValue.ParamWindowedValueCoder<?> fromComponents(java.util.List<Coder<?>> components, byte[] payload)
-
-