Package org.apache.beam.sdk.extensions.avro.io

Class AvroIO.Sink<ElementT>

java.lang.Object

org.apache.beam.sdk.extensions.avro.io.AvroIO.Sink<ElementT>

All Implemented Interfaces:

Serializable, FileIO.Sink<ElementT>

Enclosing class:

AvroIO

public abstract static class AvroIO.Sink<ElementT>
extends Object
implements FileIO.Sink<ElementT>

Implementation of AvroIO.sink(java.lang.Class<ElementT>) and AvroIO.sinkViaGenericRecords(org.apache.avro.Schema, org.apache.beam.sdk.extensions.avro.io.AvroIO.RecordFormatter<ElementT>).

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Sink()

Method Summary

Modifier and Type	Method	Description
void	flush()	Flushes the buffered state (if any) before the channel is closed.
void	open(WritableByteChannel channel)	Initializes writing to the given channel.
AvroIO.Sink<ElementT>	withCodec(CodecFactory codec)	Specifies to use the given CodecFactory for each generated file.
AvroIO.Sink<ElementT>	withDatumWriterFactory(AvroSink.DatumWriterFactory<ElementT> datumWriterFactory)	Sets a custom AvroSource.DatumReaderFactory for writing.
AvroIO.Sink<ElementT>	withMetadata(Map<String,Object> metadata)	Specifies to put the given metadata into each generated file.
void	write(ElementT element)	Appends a single element to the file.

Methods inherited from class java.lang.Object

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

Constructor Details

Sink

public Sink()

Method Details

withMetadata

public AvroIO.Sink<ElementT> withMetadata(Map<String,Object> metadata)

Specifies to put the given metadata into each generated file. By default, empty.

withCodec

public AvroIO.Sink<ElementT> withCodec(CodecFactory codec)

Specifies to use the given CodecFactory for each generated file. By default, CodecFactory.snappyCodec().

withDatumWriterFactory

public AvroIO.Sink<ElementT> withDatumWriterFactory(AvroSink.DatumWriterFactory<ElementT> datumWriterFactory)

Sets a custom AvroSource.DatumReaderFactory for writing.

open

public void open(WritableByteChannel channel)
          throws IOException

Description copied from interface: FileIO.Sink

Initializes writing to the given channel. Will be invoked once on a given FileIO.Sink instance.

Specified by:

open in interface FileIO.Sink<ElementT>

Throws:

IOException

write

public void write(ElementT element)
           throws IOException

Description copied from interface: FileIO.Sink

Appends a single element to the file. May be invoked zero or more times.

Specified by:

write in interface FileIO.Sink<ElementT>

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: FileIO.Sink

Flushes the buffered state (if any) before the channel is closed. Does not need to close the channel. Will be invoked once.

Specified by:

flush in interface FileIO.Sink<ElementT>

Throws:

IOException