Package org.apache.beam.sdk.io.gcp.bigquery

Class TableRowJsonCoder

java.lang.Object

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

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

org.apache.beam.sdk.coders.AtomicCoder<TableRow>

org.apache.beam.sdk.io.gcp.bigquery.TableRowJsonCoder

All Implemented Interfaces:

Serializable

public class TableRowJsonCoder
extends AtomicCoder<TableRow>

A Coder that encodes BigQuery TableRow objects in their native JSON format.

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
TableRow	decode(InputStream inStream)	Decodes a value of type T from the given input stream in the given context.
TableRow	decode(InputStream inStream, Coder.Context context)	Decodes a value of type T from the given input stream in the given context.
void	encode(TableRow value, OutputStream outStream)	Encodes the given value of type T onto the given output stream.
void	encode(TableRow value, OutputStream outStream, Coder.Context context)	Encodes the given value of type T onto the given output stream in the given context.
long	getEncodedElementByteSize(TableRow value)	Returns the size in bytes of the encoded value using this coder.
TypeDescriptor<TableRow>	getEncodedTypeDescriptor()	Returns the TypeDescriptor for the type encoded.
static TableRowJsonCoder	of()
void	verifyDeterministic()	Throw Coder.NonDeterministicException if the coding is not deterministic.

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

equals, getCoderArguments, getComponents, hashCode

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

toString

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

consistentWithEquals, getEncodedElementByteSizeUsingCoder, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Details

of

public static TableRowJsonCoder of()

encode

public void encode(TableRow value,
 OutputStream outStream)
            throws 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<TableRow>

Throws:

IOException - if writing to the OutputStream fails for some reason

encode

public void encode(TableRow value,
 OutputStream outStream,
 Coder.Context context)
            throws IOException

Description copied from class: Coder

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

Overrides:

encode in class Coder<TableRow>

Throws:

IOException - if writing to the OutputStream fails for some reason

decode

public TableRow decode(InputStream inStream)
                throws 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<TableRow>

Throws:

IOException - if reading from the InputStream fails for some reason

decode

public TableRow decode(InputStream inStream,
 Coder.Context context)
                throws 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.

Overrides:

decode in class Coder<TableRow>

Throws:

IOException - if reading from the InputStream fails for some reason

getEncodedElementByteSize

public long getEncodedElementByteSize(TableRow value)
                               throws Exception

Description copied from class: Coder

Returns the size in bytes of the encoded value using this coder.

Overrides:

getEncodedElementByteSize in class Coder<TableRow>

Throws:

Exception

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

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.

.

Unless overridden, does not throw. An AtomicCoder is presumed to be deterministic

Overrides:

verifyDeterministic in class AtomicCoder<TableRow>

Throws:

Coder.NonDeterministicException - always. A TableRow can hold arbitrary Object instances, which makes the encoding non-deterministic.

getEncodedTypeDescriptor

public TypeDescriptor<TableRow> getEncodedTypeDescriptor()

Description copied from class: Coder

Returns the TypeDescriptor for the type encoded.

Overrides:

getEncodedTypeDescriptor in class Coder<TableRow>