org.apache.flink.api.java.operators

Interface UdfOperator<O extends UdfOperator<O>>

All Known Implementing Classes:

CoGroupOperator, CoGroupRawOperator, CrossOperator, CrossOperator.DefaultCross, CrossOperator.ProjectCross, FilterOperator, FlatMapOperator, GroupCombineOperator, GroupReduceOperator, JoinOperator, JoinOperator.DefaultJoin, JoinOperator.EquiJoin, JoinOperator.ProjectJoin, MapOperator, MapPartitionOperator, ReduceOperator, SingleInputUdfOperator, TwoInputUdfOperator

@Public
public interface UdfOperator<O extends UdfOperator<O>>

This interface marks operators as operators that execute user-defined functions (UDFs), such as RichMapFunction, RichReduceFunction, or RichCoGroupFunction. The UDF operators stand in contrast to operators that execute built-in operations, like aggregations.

Method Summary

Modifier and Type	Method and Description
Map<String,DataSet<?>>	getBroadcastSets() Gets the broadcast sets (name and data set) that have been added to context of the UDF.
org.apache.flink.configuration.Configuration	getParameters() Gets the configuration parameters that will be passed to the UDF's open method AbstractRichFunction.open(Configuration).
org.apache.flink.api.common.operators.SemanticProperties	getSemanticProperties() Gets the semantic properties that have been set for the user-defined functions (UDF).
O	withBroadcastSet(DataSet<?> data, String name) Adds a certain data set as a broadcast set to this operator.
O	withParameters(org.apache.flink.configuration.Configuration parameters) Sets the configuration parameters for the UDF.

Method Detail

getParameters

org.apache.flink.configuration.Configuration getParameters()

Gets the configuration parameters that will be passed to the UDF's open method AbstractRichFunction.open(Configuration). The configuration is set via the withParameters(Configuration) method.

Returns:

The configuration parameters for the UDF.

getBroadcastSets

@Internal
Map<String,DataSet<?>> getBroadcastSets()

Gets the broadcast sets (name and data set) that have been added to context of the UDF. Broadcast sets are added to a UDF via the method withBroadcastSet(DataSet, String).

Returns:

The broadcast data sets that have been added to this UDF.

getSemanticProperties

@Internal
org.apache.flink.api.common.operators.SemanticProperties getSemanticProperties()

Gets the semantic properties that have been set for the user-defined functions (UDF).

Returns:

The semantic properties of the UDF.

withParameters

O withParameters(org.apache.flink.configuration.Configuration parameters)

Sets the configuration parameters for the UDF. These are optional parameters that are passed to the UDF in the AbstractRichFunction.open(Configuration) method.

Parameters:

parameters - The configuration parameters for the UDF.

Returns:

The operator itself, to allow chaining function calls.

withBroadcastSet

O withBroadcastSet(DataSet<?> data,
                   String name)

Adds a certain data set as a broadcast set to this operator. Broadcasted data sets are available at all parallel instances of this operator. A broadcast data set is registered under a certain name, and can be retrieved under that name from the operators runtime context via RuntimeContext.getBroadcastVariable(String).

The runtime context itself is available in all UDFs via AbstractRichFunction.getRuntimeContext().

Parameters:

data - The data set to be broadcast.

name - The name under which the broadcast data set retrieved.

Returns:

The operator itself, to allow chaining function calls.