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

Interface SinkFunction<IN>

Type Parameters:

IN - Input type parameter.

All Superinterfaces:

org.apache.flink.api.common.functions.Function, Serializable

All Known Implementing Classes:

CollectSink, CollectSinkFunction, DiscardingSink, OutputFormatSinkFunction, PrintSinkFunction, RichSinkFunction, SocketClientSink, StreamingFileSink, TwoPhaseCommitSinkFunction, WriteSinkFunction, WriteSinkFunctionByMillis

@Public
public interface SinkFunction<IN>
extends org.apache.flink.api.common.functions.Function, Serializable

Interface for implementing user defined sink functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SinkFunction.Context Context that SinkFunctions can use for getting additional data about an input record.

Method Summary

Modifier and Type	Method and Description
default void	invoke(IN value) Deprecated. Use invoke(Object, Context).
default void	invoke(IN value, SinkFunction.Context context) Writes the given value to the sink.

Method Detail

invoke

@Deprecated
default void invoke(IN value)
                         throws Exception

Deprecated. Use invoke(Object, Context).

Throws:

Exception

invoke

default void invoke(IN value,
                    SinkFunction.Context context)
             throws Exception

Writes the given value to the sink. This function is called for every record.

You have to override this method when implementing a SinkFunction, this is a default method for backward compatibility with the old-style method only.

Parameters:

value - The input record.

context - Additional context about the input record.

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.