org.apache.beam.sdk.coders

Class BeamRecordCoder

java.lang.Object

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

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

org.apache.beam.sdk.coders.BeamRecordCoder

All Implemented Interfaces:

java.io.Serializable

@Experimental
public class BeamRecordCoder
extends CustomCoder<BeamRecord>

A Coder for BeamRecord. It wraps the Coder for each element directly.

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 and Description
BeamRecord	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
void	encode(BeamRecord value, java.io.OutputStream outStream) Encodes the given value of type T onto the given output stream.
java.util.List<Coder>	getCoders()
BeamRecordType	getRecordType()
static BeamRecordCoder	of(BeamRecordType recordType, java.util.List<Coder> coderArray)
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

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

getCoderArguments

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

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

Methods inherited from class java.lang.Object

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

Method Detail

of

public static BeamRecordCoder of(BeamRecordType recordType,
                                 java.util.List<Coder> coderArray)

getRecordType

public BeamRecordType getRecordType()

encode

public void encode(BeamRecord value,
                   java.io.OutputStream outStream)
            throws CoderException,
                   java.io.IOException

Description copied from class: Coder

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

Specified by:

encode in class Coder<BeamRecord>

Throws:

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

java.io.IOException - if writing to the OutputStream fails for some reason

decode

public BeamRecord decode(java.io.InputStream inStream)
                  throws CoderException,
                         java.io.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.

Specified by:

decode in class Coder<BeamRecord>

Throws:

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

java.io.IOException - if reading from the InputStream fails for some reason

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

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

getCoders

public java.util.List<Coder> getCoders()