org.apache.flink.streaming.api.operators

类 AbstractUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function>

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<OUT>

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT,F>

类型参数:

OUT - The output type of the operator

F - The type of the user function

所有已实现的接口:

Serializable, org.apache.flink.runtime.state.CheckpointListener, KeyContext, OutputTypeConfigurable<OUT>, SetupableStreamOperator<OUT>, StreamOperator<OUT>, org.apache.flink.util.Disposable

直接已知子类:

AsyncWaitOperator, CoBroadcastWithKeyedOperator, CoBroadcastWithNonKeyedOperator, CoProcessOperator, CoStreamFlatMap, CoStreamMap, ExtractTimestampsOperator, IntervalJoinOperator, KeyedCoProcessOperator, KeyedProcessOperator, LegacyKeyedCoProcessOperator, LegacyKeyedProcessOperator, ProcessOperator, StreamFilter, StreamFlatMap, StreamGroupedFold, StreamGroupedReduce, StreamMap, StreamSink, StreamSource, TimestampsAndPeriodicWatermarksOperator, TimestampsAndPunctuatedWatermarksOperator, WindowOperator

@PublicEvolving
public abstract class AbstractUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function>
extends AbstractStreamOperator<OUT>
implements OutputTypeConfigurable<OUT>

This is used as the base class for operators that have a user-defined function. This class handles the opening and closing of the user-defined functions, as part of the operator life cycle.

另请参阅:

序列化表格

嵌套类概要

从类继承的嵌套类/接口 org.apache.flink.streaming.api.operators.AbstractStreamOperator

AbstractStreamOperator.CountingOutput<OUT>

字段概要

字段

限定符和类型	字段和说明
protected F	userFunction The user function.

从类继承的字段 org.apache.flink.streaming.api.operators.AbstractStreamOperator

chainingStrategy, config, latencyStats, LOG, metrics, output, timeServiceManager

构造器概要

构造器

构造器和说明
AbstractUdfStreamOperator(F userFunction)

方法概要

限定符和类型	方法和说明
void	close() This method is called after all records have been added to the operators via the methods OneInputStreamOperator.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).
void	dispose() This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.
F	getUserFunction() Gets the user function executed in this operator.
org.apache.flink.configuration.Configuration	getUserFunctionParameters() Since the streaming API does not implement any parametrization of functions via a configuration, the config returned here is actually empty.
void	initializeState(org.apache.flink.runtime.state.StateInitializationContext context) Stream operators with state which can be restored need to override this hook method.
void	notifyCheckpointComplete(long checkpointId)
void	open() This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.
void	setOutputType(org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo, org.apache.flink.api.common.ExecutionConfig executionConfig) Is called by the org.apache.flink.streaming.api.graph.StreamGraph#addOperator(Integer, String, StreamOperator, TypeInformation, TypeInformation, String) method when the StreamGraph is generated.
void	setup(StreamTask<?,?> containingTask, StreamConfig config, Output<StreamRecord<OUT>> output) Initializes the operator.
void	snapshotState(org.apache.flink.runtime.state.StateSnapshotContext context) Stream operators with state, which want to participate in a snapshot need to override this hook method.

从类继承的方法 org.apache.flink.streaming.api.operators.AbstractStreamOperator

getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getUserCodeClassloader, initializeState, numEventTimeTimers, numProcessingTimeTimers, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark, processWatermark1, processWatermark2, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, snapshotState

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

userFunction

protected final F extends org.apache.flink.api.common.functions.Function userFunction

The user function.

构造器详细资料

AbstractUdfStreamOperator

public AbstractUdfStreamOperator(F userFunction)

方法详细资料

getUserFunction

public F getUserFunction()

Gets the user function executed in this operator.

返回:

The user function of this operator.

setup

public void setup(StreamTask<?,?> containingTask,
                  StreamConfig config,
                  Output<StreamRecord<OUT>> output)

从接口复制的说明: SetupableStreamOperator

Initializes the operator. Sets access to the context and the output.

指定者:

setup 在接口中 SetupableStreamOperator<OUT>

覆盖:

setup 在类中 AbstractStreamOperator<OUT>

snapshotState

public void snapshotState(org.apache.flink.runtime.state.StateSnapshotContext context)
                   throws Exception

从类复制的说明: AbstractStreamOperator

Stream operators with state, which want to participate in a snapshot need to override this hook method.

覆盖:

snapshotState 在类中 AbstractStreamOperator<OUT>

参数:

context - context that provides information and means required for taking a snapshot

抛出:

Exception

initializeState

public void initializeState(org.apache.flink.runtime.state.StateInitializationContext context)
                     throws Exception

从类复制的说明: AbstractStreamOperator

Stream operators with state which can be restored need to override this hook method.

覆盖:

initializeState 在类中 AbstractStreamOperator<OUT>

参数:

context - context that allows to register different states.

抛出:

Exception

open

public void open()
          throws Exception

从类复制的说明: AbstractStreamOperator

This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

The default implementation does nothing.

指定者:

open 在接口中 StreamOperator<OUT>

覆盖:

open 在类中 AbstractStreamOperator<OUT>

抛出:

Exception - An exception in this method causes the operator to fail.

close

public void close()
           throws Exception

从类复制的说明: AbstractStreamOperator

This method is called after all records have been added to the operators via the methods OneInputStreamOperator.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).

The method is expected to flush all remaining buffered data. Exceptions during this flushing of buffered should be propagated, in order to cause the operation to be recognized asa failed, because the last data items are not processed properly.

指定者:

close 在接口中 StreamOperator<OUT>

覆盖:

close 在类中 AbstractStreamOperator<OUT>

抛出:

Exception - An exception in this method causes the operator to fail.

dispose

public void dispose()
             throws Exception

从类复制的说明: AbstractStreamOperator

This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.

This method is expected to make a thorough effort to release all resources that the operator has acquired.

指定者:

dispose 在接口中 StreamOperator<OUT>

指定者:

dispose 在接口中 org.apache.flink.util.Disposable

覆盖:

dispose 在类中 AbstractStreamOperator<OUT>

抛出:

Exception

notifyCheckpointComplete

public void notifyCheckpointComplete(long checkpointId)
                              throws Exception

指定者:

notifyCheckpointComplete 在接口中 org.apache.flink.runtime.state.CheckpointListener

覆盖:

notifyCheckpointComplete 在类中 AbstractStreamOperator<OUT>

抛出:

Exception

setOutputType

public void setOutputType(org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo,
                          org.apache.flink.api.common.ExecutionConfig executionConfig)

从接口复制的说明: OutputTypeConfigurable

Is called by the org.apache.flink.streaming.api.graph.StreamGraph#addOperator(Integer, String, StreamOperator, TypeInformation, TypeInformation, String) method when the StreamGraph is generated. The method is called with the output TypeInformation which is also used for the StreamTask output serializer.

指定者:

setOutputType 在接口中 OutputTypeConfigurable<OUT>

参数:

outTypeInfo - Output type information of the StreamTask

executionConfig - Execution configuration

getUserFunctionParameters

public org.apache.flink.configuration.Configuration getUserFunctionParameters()

Since the streaming API does not implement any parametrization of functions via a configuration, the config returned here is actually empty.

返回:

The user function parameters (currently empty)