Package org.apache.flink.connector.file.sink

Class FileSink.BulkFormatBuilder<IN,T extends FileSink.BulkFormatBuilder<IN,T>>

java.lang.Object

org.apache.flink.connector.file.sink.FileSink.BulkFormatBuilder<IN,T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FileSink.DefaultBulkFormatBuilder

Enclosing class:

FileSink<IN>

@PublicEvolving
public static class FileSink.BulkFormatBuilder<IN,T extends FileSink.BulkFormatBuilder<IN,T>>
extends Object

A builder for configuring the sink for bulk-encoding formats, e.g. Parquet/ORC.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final long	DEFAULT_BUCKET_CHECK_INTERVAL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BulkFormatBuilder(org.apache.flink.core.fs.Path basePath, long bucketCheckInterval, org.apache.flink.api.common.serialization.BulkWriter.Factory<IN> writerFactory, org.apache.flink.streaming.api.functions.sink.filesystem.BucketAssigner<IN,String> assigner, org.apache.flink.streaming.api.functions.sink.filesystem.rollingpolicies.CheckpointRollingPolicy<IN,String> policy, FileWriterBucketFactory<IN> bucketFactory, org.apache.flink.streaming.api.functions.sink.filesystem.OutputFileConfig outputFileConfig)
protected	BulkFormatBuilder(org.apache.flink.core.fs.Path basePath, org.apache.flink.api.common.serialization.BulkWriter.Factory<IN> writerFactory, org.apache.flink.streaming.api.functions.sink.filesystem.BucketAssigner<IN,String> assigner)

Method Summary

Modifier and Type	Method	Description
FileSink<IN>	build()	Creates the actual sink.
T	disableCompact()
T	disableLocalWriting()
T	enableCompact(FileCompactStrategy strategy, FileCompactor compactor)
protected T	self()
T	withBucketAssigner(org.apache.flink.streaming.api.functions.sink.filesystem.BucketAssigner<IN,String> assigner)
T	withBucketCheckInterval(long interval)
FileSink.BulkFormatBuilder<IN,? extends FileSink.BulkFormatBuilder<IN,?>>	withNewBucketAssigner(org.apache.flink.streaming.api.functions.sink.filesystem.BucketAssigner<IN,String> assigner)
T	withOutputFileConfig(org.apache.flink.streaming.api.functions.sink.filesystem.OutputFileConfig outputFileConfig)
T	withRollingPolicy(org.apache.flink.streaming.api.functions.sink.filesystem.rollingpolicies.CheckpointRollingPolicy<IN,String> rollingPolicy)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BUCKET_CHECK_INTERVAL

protected static final long DEFAULT_BUCKET_CHECK_INTERVAL

See Also:

• Constant Field Values

Constructor Details

BulkFormatBuilder

protected BulkFormatBuilder(org.apache.flink.core.fs.Path basePath,
 org.apache.flink.api.common.serialization.BulkWriter.Factory<IN> writerFactory,
 org.apache.flink.streaming.api.functions.sink.filesystem.BucketAssigner<IN,String> assigner)

BulkFormatBuilder

protected BulkFormatBuilder(org.apache.flink.core.fs.Path basePath,
 long bucketCheckInterval,
 org.apache.flink.api.common.serialization.BulkWriter.Factory<IN> writerFactory,
 org.apache.flink.streaming.api.functions.sink.filesystem.BucketAssigner<IN,String> assigner,
 org.apache.flink.streaming.api.functions.sink.filesystem.rollingpolicies.CheckpointRollingPolicy<IN,String> policy,
 FileWriterBucketFactory<IN> bucketFactory,
 org.apache.flink.streaming.api.functions.sink.filesystem.OutputFileConfig outputFileConfig)

Method Details

withBucketCheckInterval

public T withBucketCheckInterval(long interval)

withBucketAssigner

public T withBucketAssigner(org.apache.flink.streaming.api.functions.sink.filesystem.BucketAssigner<IN,String> assigner)

withRollingPolicy

public T withRollingPolicy(org.apache.flink.streaming.api.functions.sink.filesystem.rollingpolicies.CheckpointRollingPolicy<IN,String> rollingPolicy)

disableLocalWriting

public T disableLocalWriting()

withOutputFileConfig

public T withOutputFileConfig(org.apache.flink.streaming.api.functions.sink.filesystem.OutputFileConfig outputFileConfig)

withNewBucketAssigner

public FileSink.BulkFormatBuilder<IN,? extends FileSink.BulkFormatBuilder<IN,?>> withNewBucketAssigner(org.apache.flink.streaming.api.functions.sink.filesystem.BucketAssigner<IN,String> assigner)

enableCompact

public T enableCompact(FileCompactStrategy strategy,
 FileCompactor compactor)

disableCompact

public T disableCompact()

build

public FileSink<IN> build()

Creates the actual sink.

self

protected T self()