org.apache.flink.api.connector.sink2

Interface StatefulSink<InputT,WriterStateT>

Type Parameters:

InputT - The type of the sink's input

WriterStateT - The type of the sink writer's state

All Superinterfaces:

Serializable, Sink<InputT>, SupportsWriterState<InputT,WriterStateT>

All Known Implementing Classes:

AsyncSinkBase

Deprecated.

Please implement Sink and SupportsWriterState instead.

@PublicEvolving
 @Deprecated
public interface StatefulSink<InputT,WriterStateT>
extends Sink<InputT>, SupportsWriterState<InputT,WriterStateT>

A Sink with a stateful SinkWriter.

The StatefulSink needs to be serializable. All configuration should be validated eagerly. The respective sink writers are transient and will only be created in the subtasks on the taskmanagers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StatefulSink.StatefulSinkWriter<InputT,WriterStateT> Deprecated. A SinkWriter whose state needs to be checkpointed.
static interface	StatefulSink.WithCompatibleState Deprecated. A mix-in for StatefulSink that allows users to migrate from a sink with a compatible state to this sink.

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

Sink.InitContext, Sink.InitContextWrapper

Method Summary

Modifier and Type	Method and Description
default StatefulSink.StatefulSinkWriter<InputT,WriterStateT>	restoreWriter(Sink.InitContext context, Collection<WriterStateT> recoveredState) Deprecated. Create a StatefulSinkWriter from a recovered state.
default StatefulSink.StatefulSinkWriter<InputT,WriterStateT>	restoreWriter(WriterInitContext context, Collection<WriterStateT> recoveredState) Deprecated. Create a StatefulSinkWriter from a recovered state.

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

createWriter, createWriter

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

getWriterStateSerializer

Method Detail

restoreWriter

default StatefulSink.StatefulSinkWriter<InputT,WriterStateT> restoreWriter(Sink.InitContext context,
                                                                           Collection<WriterStateT> recoveredState)
                                                                    throws IOException

Deprecated.

Create a StatefulSinkWriter from a recovered state.

Parameters:

context - the runtime context.

Returns:

A sink writer.

Throws:

IOException - for any failure during creation.

restoreWriter

default StatefulSink.StatefulSinkWriter<InputT,WriterStateT> restoreWriter(WriterInitContext context,
                                                                           Collection<WriterStateT> recoveredState)
                                                                    throws IOException

Deprecated.

Create a StatefulSinkWriter from a recovered state.

Specified by:

restoreWriter in interface SupportsWriterState<InputT,WriterStateT>

Parameters:

context - the runtime context.

recoveredState - the state to recover from.

Returns:

A sink writer.

Throws:

IOException - for any failure during creation.