Package org.apache.beam.sdk.io

Class FileBasedSink.FileResultCoder<DestinationT>

java.lang.Object

org.apache.beam.sdk.coders.Coder<FileBasedSink.FileResult<DestinationT>>

org.apache.beam.sdk.coders.StructuredCoder<FileBasedSink.FileResult<DestinationT>>

org.apache.beam.sdk.io.FileBasedSink.FileResultCoder<DestinationT>

All Implemented Interfaces:

Serializable

Enclosing class:

FileBasedSink<UserT,DestinationT,OutputT>

public static final class FileBasedSink.FileResultCoder<DestinationT>
extends StructuredCoder<FileBasedSink.FileResult<DestinationT>>

A coder for FileBasedSink.FileResult objects.

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

Modifier	Constructor	Description
protected	FileResultCoder(Coder<BoundedWindow> windowCoder, Coder<DestinationT> destinationCoder)

Method Summary

Modifier and Type	Method	Description
FileBasedSink.FileResult<DestinationT>	decode(InputStream inStream)	Decodes a value of type T from the given input stream in the given context.
void	encode(FileBasedSink.FileResult<DestinationT> value, 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.
List<? extends Coder<?>>	getComponents()	Returns the list of Coders that are components of this Coder.
static <DestinationT> FileBasedSink.FileResultCoder<DestinationT>	of(Coder<BoundedWindow> windowCoder, Coder<DestinationT> destinationCoder)
void	verifyDeterministic()	Throw Coder.NonDeterministicException if the coding is not deterministic.

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

equals, hashCode, toString

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, wait, wait, wait

Constructor Details

FileResultCoder

protected FileResultCoder(Coder<BoundedWindow> windowCoder,
 Coder<DestinationT> destinationCoder)

Method Details

of

public static <DestinationT>
FileBasedSink.FileResultCoder<DestinationT> of(Coder<BoundedWindow> windowCoder,
 Coder<DestinationT> destinationCoder)

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<FileBasedSink.FileResult<DestinationT>>

getComponents

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

Description copied from class: StructuredCoder

Returns the list of Coders that are components of this Coder.

The default components will be equal to the value returned by Coder.getCoderArguments().

Overrides:

getComponents in class StructuredCoder<FileBasedSink.FileResult<DestinationT>>

encode

public void encode(FileBasedSink.FileResult<DestinationT> 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<FileBasedSink.FileResult<DestinationT>>

Throws:

IOException - if writing to the OutputStream fails for some reason

decode

public FileBasedSink.FileResult<DestinationT> 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<FileBasedSink.FileResult<DestinationT>>

Throws:

IOException - if reading from the InputStream fails 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<FileBasedSink.FileResult<DestinationT>>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.