org.apache.flink.api.common.functions

Interface RichFunction

All Superinterfaces:

Function, Serializable

All Known Subinterfaces:

FilterCondition, JoinCondition

All Known Implementing Classes:

AbstractRichFunction, AbstractRowTimeUnboundedPrecedingOver, AbstractTopNFunction, AggregateApplyAllWindowFunction, AggregateApplyWindowFunction, AggregateEvictingWindowReaderFunction, AppendOnlyFirstNFunction, AppendOnlyTopNFunction, ArrowSourceFunction, ArtificalOperatorStateMapper, ArtificialKeyedStateMapper, AssignRangeIndex, AsyncFunctionRunner, AsyncLookupJoinRunner, AsyncLookupJoinWithCalcRunner, BaseBroadcastProcessFunction, BatchPartitionCommitterSink, BlockingIncrementingMapFunction, BoundedOneInputStreamTaskRunner, BoundedOutOfOrderWatermarkGenerator, BroadcastProcessFunction, BroadcastStateBootstrapFunction, BulkIterationBase.TerminationCriterionMapper, CollectSink, CollectSinkFunction, ContinuousFileMonitoringFunction, CoProcessFunction, DataGeneratorSource, EmptyFieldsCountAccumulator.EmptyFieldFilter, EvictingWindowReaderFunction, FailureMapper, FastTop1Function, FlatMapIterator, FromSplittableIteratorFunction, GroupAggFunction, GroupReduceIterator, GroupTableAggFunction, HadoopMapFunction, HadoopReduceCombineFunction, HadoopReduceFunction, InputFormatSourceFunction, InternalAggregateProcessAllWindowFunction, InternalAggregateProcessWindowFunction, InternalIterableAllWindowFunction, InternalIterableProcessAllWindowFunction, InternalIterableProcessWindowFunction, InternalIterableWindowFunction, InternalSingleValueAllWindowFunction, InternalSingleValueProcessAllWindowFunction, InternalSingleValueProcessWindowFunction, InternalSingleValueWindowFunction, IntervalJoinFunction, IterateExample.Step, IterativeConditionRunner, JoinConditionWithNullFilters, JoinOperator.DefaultJoin.WrappingFlatJoinFunction, KeyedBroadcastProcessFunction, KeyedCoProcessFunction, KeyedLookupJoinWrapper, KeyedProcessFunction, KeyedProcessFunctionWithCleanupState, KeyedStateBootstrapFunction, KeyedStateReaderFunction, KeyExtractingMapper, KeyRemovingMapper, KMeans.SelectNearestCenter, ListenableCollector, LookupJoinRunner, LookupJoinWithCalcRunner, MessageAcknowledgingSourceBase, MultipleIdsMessageAcknowledgingSourceBase, NoOpFunction, OperatorSubtaskStateReducer, OutputFormatSinkFunction, PassThroughReader, PatternFlatSelectAdapter, PatternProcessFunction, PatternProcessFunctionRunner, PatternSelectAdapter, PatternTimeoutFlatSelectAdapter, PatternTimeoutSelectAdapter, PlanFilterOperator.FlatMapFilter, PrintSinkFunction, ProcessAllWindowFunction, ProcessEvictingWindowReader, ProcessFunction, ProcessJoinFunction, ProcessWindowFunction, ProcTimeDeduplicateKeepFirstRowFunction, ProcTimeDeduplicateKeepLastRowFunction, ProcTimeIntervalJoin, ProcTimeRangeBoundedPrecedingFunction, ProcTimeRowsBoundedPrecedingFunction, ProcTimeUnboundedPrecedingFunction, PythonConnectorUtils.RowRowMapper, RangeBoundaryBuilder, ReduceApplyAllWindowFunction, ReduceApplyProcessAllWindowFunction, ReduceApplyProcessWindowFunction, ReduceApplyWindowFunction, ReduceEvictingWindowReaderFunction, RetractableTopNFunction, RichAggregateFunction, RichAllWindowFunction, RichAndCondition, RichAsyncFunction, RichCoFlatMapFunction, RichCoGroupFunction, RichCoMapFunction, RichCombineToGroupCombineWrapper, RichCompositeIterativeCondition, RichCrossFunction, RichFilterFunction, RichFlatJoinFunction, RichFlatMapFunction, RichGroupCombineFunction, RichGroupReduceFunction, RichIterativeCondition, RichJoinFunction, RichMapFunction, RichMapPartitionFunction, RichNotCondition, RichOrCondition, RichParallelSourceFunction, RichPatternFlatSelectFunction, RichPatternSelectFunction, RichProcessAllWindowFunction, RichProcessWindowFunction, RichReduceFunction, RichSinkFunction, RichSourceFunction, RichWindowFunction, RowTimeDeduplicateFunction, RowTimeIntervalJoin, RowTimeRangeBoundedPrecedingFunction, RowTimeRangeUnboundedPrecedingFunction, RowTimeRowsBoundedPrecedingFunction, RowTimeRowsUnboundedPrecedingFunction, SampleInPartition, SampleWithFraction, SemanticsCheckMapper, SequenceGeneratorSource, SideOutputExample.Tokenizer, SlidingWindowCheckMapper, SocketClientSink, StateBootstrapFunction, StatefulSequenceSource, StatefulStreamingJob.MySource, StatefulStreamingJob.MyStatefulFunction, StreamingFileSink, TableFunctionCollector, TableFunctionResultFuture, TestListResultSink, TupleLeftUnwrappingJoiner, TupleRightUnwrappingJoiner, TupleUnwrappingJoiner, TwoKeyExtractingMapper, TwoPhaseCommitSinkFunction, UpdatableTopNFunction, WatermarkGenerator, WikipediaEditsSource, WindowReaderFunction, WrappingCollector, WrappingFunction

@Public
public interface RichFunction
extends Function

An base interface for all rich user-defined functions. This class defines methods for the life cycle of the functions, as well as methods to access the context in which the functions are executed.

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for the user code.
IterationRuntimeContext	getIterationRuntimeContext() Gets a specialized version of the RuntimeContext, which has additional information about the iteration in which the function is executed.
RuntimeContext	getRuntimeContext() Gets the context that contains information about the UDF's runtime, such as the parallelism of the function, the subtask index of the function, or the name of the task that executes the function.
void	open(Configuration parameters) Deprecated. This method is deprecated since Flink 1.19. The users are recommended to implement open(OpenContext openContext) and implement open(Configuration parameters) with an empty body instead. 1. If you implement open(OpenContext openContext), the open(OpenContext openContext) will be invoked and the open(Configuration parameters) won't be invoked. 2. If you don't implement open(OpenContext openContext), the open(Configuration parameters) will be invoked in the default implementation of the open(OpenContext openContext).
default void	open(OpenContext openContext) Initialization method for the function.
void	setRuntimeContext(RuntimeContext t) Sets the function's runtime context.

Method Detail

open

@Deprecated
void open(Configuration parameters)
               throws Exception

Deprecated. This method is deprecated since Flink 1.19. The users are recommended to implement open(OpenContext openContext) and implement open(Configuration parameters) with an empty body instead. 1. If you implement open(OpenContext openContext), the open(OpenContext openContext) will be invoked and the open(Configuration parameters) won't be invoked. 2. If you don't implement open(OpenContext openContext), the open(Configuration parameters) will be invoked in the default implementation of the open(OpenContext openContext).

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The configuration object passed to the function can be used for configuration and initialization. The configuration contains all parameters that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(Configuration parameters) {
         this.searchString = parameters.getString("foo");
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

Parameters:

parameters - The configuration containing the parameters attached to the contract.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

See Also:

Configuration, FLIP-344: Remove parameter in RichFunction#open

open

@PublicEvolving
default void open(OpenContext openContext)
                           throws Exception

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The openContext object passed to the function can be used for configuration and initialization. The openContext contains some necessary information that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(OpenContext openContext) {
         // initialize the value of searchString
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

1. If you implement open(OpenContext openContext), the open(OpenContext openContext) will be invoked and the open(Configuration parameters) won't be invoked. 2. If you don't implement open(OpenContext openContext), the open(Configuration parameters) will be invoked in the default implementation of the open(OpenContext openContext).

Parameters:

openContext - The context containing information about the context in which the function is opened.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

close

void close()
    throws Exception

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

getRuntimeContext

RuntimeContext getRuntimeContext()

Gets the context that contains information about the UDF's runtime, such as the parallelism of the function, the subtask index of the function, or the name of the task that executes the function.

The RuntimeContext also gives access to the Accumulators and the DistributedCache.

Returns:

The UDF's runtime context.

getIterationRuntimeContext

IterationRuntimeContext getIterationRuntimeContext()

Gets a specialized version of the RuntimeContext, which has additional information about the iteration in which the function is executed. This IterationRuntimeContext is only available if the function is part of an iteration. Otherwise, this method throws an exception.

Returns:

The IterationRuntimeContext.

Throws:

IllegalStateException - Thrown, if the function is not executed as part of an iteration.

setRuntimeContext

void setRuntimeContext(RuntimeContext t)

Sets the function's runtime context. Called by the framework when creating a parallel instance of the function.

Parameters:

t - The runtime context.