com.google.cloud.dataflow.sdk.coders

Class EntityCoder

java.lang.Object

com.google.cloud.dataflow.sdk.coders.StandardCoder<T>

com.google.cloud.dataflow.sdk.coders.DeterministicStandardCoder<T>

com.google.cloud.dataflow.sdk.coders.AtomicCoder<com.google.api.services.datastore.DatastoreV1.Entity>

com.google.cloud.dataflow.sdk.coders.EntityCoder

All Implemented Interfaces:

Coder<com.google.api.services.datastore.DatastoreV1.Entity>, Serializable

public class EntityCoder
extends AtomicCoder<com.google.api.services.datastore.DatastoreV1.Entity>

An EntityCoder is a Coder for DatastoreV1.Entity objects.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
com.google.api.services.datastore.DatastoreV1.Entity	decode(InputStream inStream, Coder.Context context) Decodes a value of type T from the given input stream in the given context.
void	encode(com.google.api.services.datastore.DatastoreV1.Entity value, OutputStream outStream, Coder.Context context) Encodes the given value of type T onto the given output stream in the given context.
protected long	getEncodedElementByteSize(com.google.api.services.datastore.DatastoreV1.Entity value, Coder.Context context) Returns the size in bytes of the encoded value using this coder.
static EntityCoder	of()
void	verifyDeterministic() A datastore kind can hold arbitrary Object instances, which makes the encoding non-deterministic.

Methods inherited from class com.google.cloud.dataflow.sdk.coders.AtomicCoder

getCoderArguments, getInstanceComponents

Methods inherited from class com.google.cloud.dataflow.sdk.coders.StandardCoder

asCloudObject, consistentWithEquals, equals, getComponents, hashCode, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, toString, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

of

public static EntityCoder of()

encode

public void encode(com.google.api.services.datastore.DatastoreV1.Entity value,
                   OutputStream outStream,
                   Coder.Context context)
            throws IOException,
                   CoderException

Description copied from interface: Coder

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

Throws:

IOException - if writing to the OutputStream fails for some reason

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

decode

public com.google.api.services.datastore.DatastoreV1.Entity decode(InputStream inStream,
                                                                   Coder.Context context)
                                                            throws IOException

Description copied from interface: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Throws:

IOException - if reading from the InputStream fails for some reason

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

getEncodedElementByteSize

protected long getEncodedElementByteSize(com.google.api.services.datastore.DatastoreV1.Entity value,
                                         Coder.Context context)
                                  throws Exception

Description copied from class: StandardCoder

Returns the size in bytes of the encoded value using this coder. Derived classes override this method if byte size can be computed with less computation or copying.

Overrides:

getEncodedElementByteSize in class StandardCoder<com.google.api.services.datastore.DatastoreV1.Entity>

Throws:

Exception

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

A datastore kind can hold arbitrary Object instances, which makes the encoding non-deterministic.

Specified by:

verifyDeterministic in interface Coder<com.google.api.services.datastore.DatastoreV1.Entity>

Overrides:

verifyDeterministic in class DeterministicStandardCoder<com.google.api.services.datastore.DatastoreV1.Entity>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.