org.apache.flink.api.connector.sink2

Interface TwoPhaseCommittingSink.PrecommittingSinkWriter<InputT,CommT>

All Superinterfaces:

AutoCloseable, SinkWriter<InputT>

All Known Implementing Classes:

FileWriter, PulsarWriter

Enclosing interface:

TwoPhaseCommittingSink<InputT,CommT>

@PublicEvolving
public static interface TwoPhaseCommittingSink.PrecommittingSinkWriter<InputT,CommT>
extends SinkWriter<InputT>

A SinkWriter that performs the first part of a two-phase commit protocol.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.api.connector.sink2.SinkWriter

SinkWriter.Context

Method Summary

Modifier and Type	Method and Description
Collection<CommT>	prepareCommit() Prepares for a commit.

Methods inherited from interface org.apache.flink.api.connector.sink2.SinkWriter

flush, write, writeWatermark

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

prepareCommit

Collection<CommT> prepareCommit()
                         throws IOException,
                                InterruptedException

Prepares for a commit.

This method will be called after SinkWriter.flush(boolean) and before StatefulSink.StatefulSinkWriter.snapshotState(long).

Returns:

The data to commit as the second step of the two-phase commit protocol.

Throws:

IOException - if fail to prepare for a commit.

InterruptedException