org.apache.gobblin.writer

Class FluentDataWriterBuilder<S,D,B extends FluentDataWriterBuilder<S,D,B>>

java.lang.Object

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

org.apache.gobblin.writer.FluentDataWriterBuilder<S,D,B>

public abstract class FluentDataWriterBuilder<S,D,B extends FluentDataWriterBuilder<S,D,B>>
extends DataWriterBuilder<S,D>

A helper class to help create fluent DataWriterBuilders. To make the Java generics magic work, classes should declare their builders as MyDataWriterBuilder and use "return typedSelf()" instead of "return this" in their setters.

Field Summary

Fields inherited from class org.apache.gobblin.writer.DataWriterBuilder

branch, branches, destination, format, schema, writerAttemptId, writerId

Constructor Summary

Constructors

Constructor and Description
FluentDataWriterBuilder()

Method Summary

Modifier and Type	Method and Description
DataWriterBuilder<S,D>	forBranch(int branch) Tell the writer which branch it is associated with.
protected B	typedSelf()
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.
B	writeInFormat(WriterOutputFormat format) Tell the writer the output format of type WriterOutputFormat.
B	writeTo(Destination destination) Tell the writer the destination to write to.

Methods inherited from class org.apache.gobblin.writer.DataWriterBuilder

build, getInitializer, withAttemptId

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentDataWriterBuilder

public FluentDataWriterBuilder()

Method Detail

typedSelf

protected B typedSelf()

writeTo

public B writeTo(Destination destination)

Description copied from class: DataWriterBuilder

Tell the writer the destination to write to.

Overrides:

writeTo in class DataWriterBuilder<S,D>

Parameters:

destination - destination to write to

Returns:

this DataWriterBuilder instance

writeInFormat

public B writeInFormat(WriterOutputFormat format)

Description copied from class: DataWriterBuilder

Tell the writer the output format of type WriterOutputFormat.

Overrides:

writeInFormat in class DataWriterBuilder<S,D>

Parameters:

format - output format of the writer

Returns:

this DataWriterBuilder instance

withWriterId

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

Description copied from class: DataWriterBuilder

Give the writer a unique ID.

Overrides:

withWriterId in class DataWriterBuilder<S,D>

Parameters:

writerId - unique writer ID

Returns:

this DataWriterBuilder instance

withSchema

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

Description copied from class: DataWriterBuilder

Tell the writer the data schema.

Overrides:

withSchema in class DataWriterBuilder<S,D>

Parameters:

schema - data schema

Returns:

this DataWriterBuilder instance

withBranches

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

Description copied from class: DataWriterBuilder

Tell the writer how many branches are being used.

Overrides:

withBranches in class DataWriterBuilder<S,D>

Parameters:

branches - is the number of branches

Returns:

this DataWriterBuilder instance

forBranch

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

Description copied from class: DataWriterBuilder

Tell the writer which branch it is associated with.

Overrides:

forBranch in class DataWriterBuilder<S,D>

Parameters:

branch - branch index

Returns:

this DataWriterBuilder instance