org.apache.gobblin.writer

Class DataWriterBuilder<S,D>

java.lang.Object

org.apache.gobblin.writer.DataWriterBuilder<S,D>

Type Parameters:

S - schema type

D - data record type

Direct Known Subclasses:

FluentDataWriterBuilder

public abstract class DataWriterBuilder<S,D>
extends Object

A builder class for DataWriter.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	branch
protected int	branches
protected Destination	destination
protected WriterOutputFormat	format
protected S	schema
protected String	writerAttemptId
protected String	writerId

Constructor Summary

Constructors

Constructor and Description
DataWriterBuilder()

Method Summary

Modifier and Type	Method and Description
abstract DataWriter<D>	build() Build a DataWriter.
DataWriterBuilder<S,D>	forBranch(int branch) Tell the writer which branch it is associated with.
WriterInitializer	getInitializer(State state, WorkUnitStream workUnits, int branches, int branchId)
DataWriterBuilder<S,D>	withAttemptId(String attemptId) Attempt Id for this writer.
DataWriterBuilder<S,D>	withBranches(int branches) Tell the writer how many branches are being used.
DataWriterBuilder<S,D>	withSchema(S schema) Tell the writer the data schema.
DataWriterBuilder<S,D>	withWriterId(String writerId) Give the writer a unique ID.
DataWriterBuilder<S,D>	writeInFormat(WriterOutputFormat format) Tell the writer the output format of type WriterOutputFormat.
DataWriterBuilder<S,D>	writeTo(Destination destination) Tell the writer the destination to write to.

Methods inherited from class java.lang.Object

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

Field Detail

destination

protected Destination destination

writerId

protected String writerId

format

protected WriterOutputFormat format

schema

protected S schema

branches

protected int branches

branch

protected int branch

writerAttemptId

protected String writerAttemptId

Constructor Detail

DataWriterBuilder

public DataWriterBuilder()

Method Detail

writeTo

public DataWriterBuilder<S,D> writeTo(Destination destination)

Tell the writer the destination to write to.

Parameters:

destination - destination to write to

Returns:

this DataWriterBuilder instance

writeInFormat

public DataWriterBuilder<S,D> writeInFormat(WriterOutputFormat format)

Tell the writer the output format of type WriterOutputFormat.

Parameters:

format - output format of the writer

Returns:

this DataWriterBuilder instance

withWriterId

public DataWriterBuilder<S,D> withWriterId(String writerId)

Give the writer a unique ID.

Parameters:

writerId - unique writer ID

Returns:

this DataWriterBuilder instance

withSchema

public DataWriterBuilder<S,D> withSchema(S schema)

Tell the writer the data schema.

Parameters:

schema - data schema

Returns:

this DataWriterBuilder instance

withBranches

public DataWriterBuilder<S,D> withBranches(int branches)

Tell the writer how many branches are being used.

Parameters:

branches - is the number of branches

Returns:

this DataWriterBuilder instance

forBranch

public DataWriterBuilder<S,D> forBranch(int branch)

Tell the writer which branch it is associated with.

Parameters:

branch - branch index

Returns:

this DataWriterBuilder instance

withAttemptId

public DataWriterBuilder<S,D> withAttemptId(String attemptId)

Attempt Id for this writer. There could be two duplicate writers with the same writerId, their writerAttemptId should be different.

getInitializer

public WriterInitializer getInitializer(State state,
                                        WorkUnitStream workUnits,
                                        int branches,
                                        int branchId)

build

public abstract DataWriter<D> build()
                             throws IOException

Build a DataWriter.

Returns:

the built DataWriter

Throws:

IOException - if there is anything wrong building the writer