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

Interface InProgressFileWriter<IN,BucketID>

All Superinterfaces:

CompactingFileWriter, PartFileInfo<BucketID>, RecordWiseCompactingFileWriter<IN>

All Known Implementing Classes:

AbstractPartFileWriter, HadoopPathBasedPartFileWriter, OutputStreamBasedPartFileWriter, RowWisePartWriter

@Internal
public interface InProgressFileWriter<IN,BucketID>
extends PartFileInfo<BucketID>, RecordWiseCompactingFileWriter<IN>

The Bucket uses the InProgressFileWriter to write element to a part file.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InProgressFileWriter.InProgressFileRecoverable A handle can be used to recover in-progress file..
static interface	InProgressFileWriter.PendingFileRecoverable The handle can be used to recover pending file.

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.sink.filesystem.CompactingFileWriter

CompactingFileWriter.Type

Method Summary

Modifier and Type	Method and Description
InProgressFileWriter.PendingFileRecoverable	closeForCommit() Closes the writer and gets the InProgressFileWriter.PendingFileRecoverable of the written compacting file.
void	dispose() Dispose the part file.
InProgressFileWriter.InProgressFileRecoverable	persist()
default void	write(IN element) Write an element to the compacting file.
void	write(IN element, long currentTime) Write an element to the part file.

Methods inherited from interface org.apache.flink.streaming.api.functions.sink.filesystem.PartFileInfo

getBucketId, getCreationTime, getLastUpdateTime, getSize

Method Detail

write

void write(IN element,
           long currentTime)
    throws IOException

Write an element to the part file.

Parameters:

element - the element to be written.

currentTime - the writing time.

Throws:

IOException - Thrown if writing the element fails.

persist

InProgressFileWriter.InProgressFileRecoverable persist()
                                                throws IOException

Returns:

The state of the current part file.

Throws:

IOException - Thrown if persisting the part file fails.

closeForCommit

InProgressFileWriter.PendingFileRecoverable closeForCommit()
                                                    throws IOException

Description copied from interface: CompactingFileWriter

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

Specified by:

closeForCommit in interface CompactingFileWriter

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.

dispose

void dispose()

Dispose the part file.

write

default void write(IN element)
            throws IOException

Description copied from interface: RecordWiseCompactingFileWriter

Write an element to the compacting file.

Specified by:

write in interface RecordWiseCompactingFileWriter<IN>

Parameters:

element - the element to be written.

Throws:

IOException - Thrown if writing the element fails.