org.apache.flink.core.fs

Interface RecoverableFsDataOutputStream.Committer

All Known Implementing Classes:

S3Committer

Enclosing class:

RecoverableFsDataOutputStream

public static interface RecoverableFsDataOutputStream.Committer

A committer can publish the file of a stream that was closed. The Committer can be recovered via a RecoverableWriter.CommitRecoverable.

Method Summary

Modifier and Type	Method and Description
void	commit() Commits the file, making it visible.
void	commitAfterRecovery() Commits the file, making it visible.
RecoverableWriter.CommitRecoverable	getRecoverable() Gets a recoverable object to recover the committer.

Method Detail

commit

void commit()
     throws IOException

Commits the file, making it visible. The file will contain the exact data as when the committer was created.

Throws:

IOException - Thrown if committing fails.

commitAfterRecovery

void commitAfterRecovery()
                  throws IOException

Commits the file, making it visible. The file will contain the exact data as when the committer was created.

This method tolerates situations where the file was already committed and will not raise an exception in that case. This is important for idempotent commit retries as they need to happen after recovery.

Throws:

IOException - Thrown if committing fails.

getRecoverable

RecoverableWriter.CommitRecoverable getRecoverable()

Gets a recoverable object to recover the committer. The recovered committer will commit the file with the exact same data as this committer would commit it.