Package org.apache.beam.sdk.transforms.join

Class CoGbkResult.CoGbkResultCoder

java.lang.Object

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

org.apache.beam.sdk.coders.CustomCoder<CoGbkResult>

org.apache.beam.sdk.transforms.join.CoGbkResult.CoGbkResultCoder

All Implemented Interfaces:

Serializable

Enclosing class:

CoGbkResult

public static class CoGbkResult.CoGbkResultCoder
extends CustomCoder<CoGbkResult>

A Coder for CoGbkResults.

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
CoGbkResult	decode(InputStream inStream)	Decodes a value of type T from the given input stream in the given context.
void	encode(CoGbkResult value, OutputStream outStream)	Encodes the given value of type T onto the given output stream.
boolean	equals(@Nullable Object object)
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.
CoGbkResultSchema	getSchema()
UnionCoder	getUnionCoder()
int	hashCode()
static CoGbkResult.CoGbkResultCoder	of(CoGbkResultSchema schema, UnionCoder unionCoder)	Returns a CoGbkResult.CoGbkResultCoder for the given schema and UnionCoder.
void	verifyDeterministic()	Throw Coder.NonDeterministicException if the coding is not deterministic.

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

consistentWithEquals, decode, encode, getEncodedElementByteSize, getEncodedElementByteSizeUsingCoder, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Details

of

public static CoGbkResult.CoGbkResultCoder of(CoGbkResultSchema schema,
 UnionCoder unionCoder)

Returns a CoGbkResult.CoGbkResultCoder for the given schema and UnionCoder.

getCoderArguments

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

Description copied from class: CustomCoder

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

Returns an empty list. A CustomCoder has no default argument coders.

Overrides:

getCoderArguments in class CustomCoder<CoGbkResult>

getSchema

public CoGbkResultSchema getSchema()

getUnionCoder

public UnionCoder getUnionCoder()

encode

public void encode(CoGbkResult value,
 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<CoGbkResult>

Throws:

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

IOException - if writing to the OutputStream fails for some reason

decode

public CoGbkResult 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<CoGbkResult>

Throws:

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

IOException - if reading from the InputStream fails for some reason

equals

public boolean equals(@Nullable Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

Description copied from class: CustomCoder

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.

Overrides:

verifyDeterministic in class CustomCoder<CoGbkResult>

Throws:

Coder.NonDeterministicException - a CustomCoder is presumed nondeterministic.