org.apache.flink.streaming.runtime.operators.asyncprocessing

类 AbstractAsyncStateUdfStreamOperator<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.runtime.operators.asyncprocessing.AbstractAsyncStateStreamOperator<OUT>

org.apache.flink.streaming.runtime.operators.asyncprocessing.AbstractAsyncStateUdfStreamOperator<OUT,F>

类型参数:

OUT - The output type of the operator

F - The type of the user function

所有已实现的接口:

Serializable, org.apache.flink.api.common.state.CheckpointListener, KeyContext, KeyContextHandler, org.apache.flink.streaming.api.operators.OutputTypeConfigurable<OUT>, SetupableStreamOperator<OUT>, StreamOperator<OUT>, StreamOperatorStateHandler.CheckpointedStreamOperator, UserFunctionProvider<F>, YieldingOperator<OUT>, AsyncStateProcessing, AsyncStateProcessingOperator

@Internal
public abstract class AbstractAsyncStateUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function>
extends AbstractAsyncStateStreamOperator<OUT>
implements org.apache.flink.streaming.api.operators.OutputTypeConfigurable<OUT>, UserFunctionProvider<F>

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. This class is nearly identical with AbstractUdfStreamOperator, but extending from AbstractAsyncStateStreamOperator to integrate with asynchronous state access. Another difference is this class is internal.

另请参阅:

序列化表格

字段概要

字段

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

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

chainingStrategy, config, lastRecordAttributes1, lastRecordAttributes2, latencyStats, LOG, metrics, output, processingTimeService, stateHandler, stateKeySelector1, stateKeySelector2, timeServiceManager

构造器概要

构造器

构造器和说明
AbstractAsyncStateUdfStreamOperator(F userFunction)

方法概要

限定符和类型	方法和说明
void	close() 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.
void	finish() This method is called at the end of data processing.
F	getUserFunction() Gets the user function executed in this operator.
void	initializeState(org.apache.flink.runtime.state.StateInitializationContext context) Stream operators with state which can be restored need to override this hook method.
void	notifyCheckpointAborted(long checkpointId)
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)
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.runtime.operators.asyncprocessing.AbstractAsyncStateStreamOperator

getCurrentKey, getElementOrder, getInternalTimerService, getRecordProcessor, initializeState, isAsyncStateProcessingEnabled, postProcessElement, preserveRecordOrderAndProcess, processWatermark, processWatermarkStatus, setAsyncKeyedContextElement, setKeyContextElement1, setKeyContextElement2, snapshotState

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

getChainingStrategy, getContainingTask, getExecutionConfig, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getStateKeySelector1, getStateKeySelector2, getTimeServiceManager, getUserCodeClassloader, hasKeyContext1, hasKeyContext2, isUsingCustomRawKeyedState, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark1, processWatermark2, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setMailboxExecutor, setProcessingTimeService, useSplittableTimers

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

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

从接口继承的方法 org.apache.flink.streaming.runtime.operators.asyncprocessing.AsyncStateProcessing

makeRecordProcessor

从接口继承的方法 org.apache.flink.streaming.api.operators.StreamOperator

getOperatorAttributes

从接口继承的方法 org.apache.flink.streaming.api.operators.KeyContextHandler

hasKeyContext

字段详细资料

userFunction

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

The user function.

构造器详细资料

AbstractAsyncStateUdfStreamOperator

public AbstractAsyncStateUdfStreamOperator(F userFunction)

方法详细资料

getUserFunction

public F getUserFunction()

Gets the user function executed in this operator.

指定者:

getUserFunction 在接口中 UserFunctionProvider<F extends org.apache.flink.api.common.functions.Function>

返回:

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 在接口中 StreamOperatorStateHandler.CheckpointedStreamOperator

覆盖:

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 在接口中 StreamOperatorStateHandler.CheckpointedStreamOperator

覆盖:

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.

finish

public void finish()
            throws Exception

从接口复制的说明: StreamOperator

This method is called at the end of data processing.

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

After this method is called, no more records can be produced for the downstream operators.

WARNING: It is not safe to use this method to commit any transactions or other side effects! You can use this method to flush any buffered data that can later on be committed e.g. in a CheckpointListener.notifyCheckpointComplete(long).

NOTE:This method does not need to close any resources. You should release external resources in the StreamOperator.close() method.

指定者:

finish 在接口中 StreamOperator<OUT>

覆盖:

finish 在类中 AbstractStreamOperator<OUT>

抛出:

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

close

public void close()
           throws Exception

从接口复制的说明: StreamOperator

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.

NOTE:It can not emit any records! If you need to emit records at the end of processing, do so in the StreamOperator.finish() method.

指定者:

close 在接口中 StreamOperator<OUT>

覆盖:

close 在类中 AbstractStreamOperator<OUT>

抛出:

Exception

notifyCheckpointComplete

public void notifyCheckpointComplete(long checkpointId)
                              throws Exception

指定者:

notifyCheckpointComplete 在接口中 org.apache.flink.api.common.state.CheckpointListener

覆盖:

notifyCheckpointComplete 在类中 AbstractStreamOperator<OUT>

抛出:

Exception

notifyCheckpointAborted

public void notifyCheckpointAborted(long checkpointId)
                             throws Exception

指定者:

notifyCheckpointAborted 在接口中 org.apache.flink.api.common.state.CheckpointListener

覆盖:

notifyCheckpointAborted 在类中 AbstractStreamOperator<OUT>

抛出:

Exception

setOutputType

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

指定者:

setOutputType 在接口中 org.apache.flink.streaming.api.operators.OutputTypeConfigurable<OUT>