Package org.apache.beam.sdk.transforms.windowing

Class IntervalWindow.IntervalWindowCoder

java.lang.Object

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

org.apache.beam.sdk.coders.StructuredCoder<IntervalWindow>

org.apache.beam.sdk.transforms.windowing.IntervalWindow.IntervalWindowCoder

All Implemented Interfaces:

Serializable

Enclosing class:

IntervalWindow

public static class IntervalWindow.IntervalWindowCoder
extends StructuredCoder<IntervalWindow>

Encodes an IntervalWindow as a pair of its upper bound and duration.

See Also:

• Serialized Form

Nested Class Summary

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

Coder.Context, Coder.NonDeterministicException

Constructor Summary

Constructors

Constructor	Description
IntervalWindowCoder()

Method Summary

Modifier and Type	Method	Description
boolean	consistentWithEquals()	Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).
IntervalWindow	decode(InputStream inStream)	Decodes a value of type T from the given input stream in the given context.
void	encode(IntervalWindow window, OutputStream outStream)	Encodes the given value of type T onto the given output stream.
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.
boolean	isRegisterByteSizeObserverCheap(IntervalWindow value)	Returns whether Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) cheap enough to call for every element, that is, if this Coder can calculate the byte size of the element to be coded in roughly constant time (or lazily).
static IntervalWindow.IntervalWindowCoder	of()
void	registerByteSizeObserver(IntervalWindow 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.

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

equals, getComponents, hashCode, toString

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

decode, encode, getEncodedElementByteSize, getEncodedElementByteSizeUsingCoder, getEncodedTypeDescriptor, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Constructor Details

IntervalWindowCoder

public IntervalWindowCoder()

Method Details

of

public static IntervalWindow.IntervalWindowCoder of()

encode

public void encode(IntervalWindow window,
 OutputStream outStream)
            throws IOException,
CoderException

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<IntervalWindow>

Throws:

IOException - if writing to the OutputStream fails for some reason

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

decode

public IntervalWindow decode(InputStream inStream)
                      throws IOException,
CoderException

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<IntervalWindow>

Throws:

IOException - if reading from the InputStream fails for some reason

CoderException - if the value could not be decoded 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<IntervalWindow>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

consistentWithEquals

public boolean consistentWithEquals()

Description copied from class: Coder

Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).

Whenever the encoded bytes of two values are equal, then the original values are equal according to Objects.equals(). Note that this is well-defined for null.

This condition is most notably false for arrays. More generally, this condition is false whenever equals() compares object identity, rather than performing a semantic/structural comparison.

By default, returns false.

Overrides:

consistentWithEquals in class Coder<IntervalWindow>

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(IntervalWindow value)

Description copied from class: Coder

Returns whether Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) cheap enough to call for every element, that is, if this Coder can calculate the byte size of the element to be coded in roughly constant time (or lazily).

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

By default, returns false. The default Coder.registerByteSizeObserver(T, org.apache.beam.sdk.util.common.ElementByteSizeObserver) implementation invokes Coder.getEncodedElementByteSize(T) which requires re-encoding an element unless it is overridden. This is considered expensive.

Overrides:

isRegisterByteSizeObserverCheap in class Coder<IntervalWindow>

registerByteSizeObserver

public void registerByteSizeObserver(IntervalWindow 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<IntervalWindow>

Throws:

Exception

getCoderArguments

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

Description copied from class: Coder

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<IntervalWindow>