org.apache.flink.streaming.api.functions.sink.filesystem

Interface CompactingFileWriter

All Known Subinterfaces:

InProgressFileWriter<IN,BucketID>, OutputStreamBasedCompactingFileWriter, RecordWiseCompactingFileWriter<IN>

All Known Implementing Classes:

AbstractPartFileWriter, HadoopPathBasedPartFileWriter, OutputStreamBasedPartFileWriter, RowWisePartWriter

@Internal
public interface CompactingFileWriter

The file sink compactors use the CompactingFileWriter to write a compacting file.

A class should not directly implement the CompactingFileWriter, but to implement the RecordWiseCompactingFileWriter, or the OutputStreamBasedCompactingFileWriter, or both. If an class implements both interfaces, once the write method of either interface is called, the write method in the other one should be disabled.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CompactingFileWriter.Type Enum defining the types of CompactingFileWriter.

Method Summary

Modifier and Type	Method and Description
InProgressFileWriter.PendingFileRecoverable	closeForCommit() Closes the writer and gets the InProgressFileWriter.PendingFileRecoverable of the written compacting file.

Method Detail

closeForCommit

InProgressFileWriter.PendingFileRecoverable closeForCommit()
                                                    throws IOException

Closes the writer and gets the InProgressFileWriter.PendingFileRecoverable of the written compacting file.

Returns:

The state of the pending part file. Bucket uses this to commit the pending file.

Throws:

IOException - Thrown if an I/O error occurs.