AbstractInvokable (Flink : Runtime 1.14.5 API)

java.lang.Object
- org.apache.flink.runtime.jobgraph.tasks.AbstractInvokable

所有已实现的接口:

CheckpointableTask, CoordinatedTask, TaskInvokable

直接已知子类:

BatchTask, DataSinkTask, DataSourceTask, IterationSynchronizationSinkTask
```
public abstract class AbstractInvokable
extends Object
implements TaskInvokable, CheckpointableTask, CoordinatedTask
```
A base implementation of TaskInvokable, CheckpointableTask, and CoordinatedTask with most methods throwing UnsupportedOperationException or doing nothing.
Any subclass that supports recoverable state and participates in checkpointing needs to override the methods of CheckpointableTask, such as triggerCheckpointAsync(CheckpointMetaData, CheckpointOptions), triggerCheckpointOnBarrier(CheckpointMetaData, CheckpointOptions, CheckpointMetricsBuilder), abortCheckpointOnBarrier(long, CheckpointException) and notifyCheckpointCompleteAsync(long).

构造器概要

构造器
构造器和说明

AbstractInvokable(Environment environment)
Create an Invokable task and set its environment.

构造器
构造器和说明
`AbstractInvokable(Environment environment)` Create an Invokable task and set its environment.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`abortCheckpointOnBarrier(long checkpointId, CheckpointException cause)` Aborts a checkpoint as the result of receiving possibly some checkpoint barriers, but at least one `CancelCheckpointMarker`.
`Future<Void>`	`cancel()` This method is called when a task is canceled either as a result of a user abort or an execution failure.
`void`	`cleanUp(Throwable throwable)` Cleanup any resources used in `TaskInvokable.invoke()` OR `TaskInvokable.restore()`.
`void`	`dispatchOperatorEvent(OperatorID operator, org.apache.flink.util.SerializedValue<OperatorEvent> event)`
`int`	`getCurrentNumberOfSubtasks()` Returns the current number of subtasks the respective task is split into.
`Environment`	`getEnvironment()` Returns the environment of this task.
`org.apache.flink.api.common.ExecutionConfig`	`getExecutionConfig()` Returns the global ExecutionConfig.
`int`	`getIndexInSubtaskGroup()` Returns the index of this subtask in the subtask group.
`org.apache.flink.configuration.Configuration`	`getJobConfiguration()` Returns the job configuration object which was attached to the original `JobGraph`.
`org.apache.flink.configuration.Configuration`	`getTaskConfiguration()` Returns the task configuration object which was attached to the original `JobVertex`.
`ClassLoader`	`getUserCodeClassLoader()` Returns the user code class loader of this invokable.
`abstract void`	`invoke()` Starts the execution.
`boolean`	`isUsingNonBlockingInput()`
`void`	`maybeInterruptOnCancel(Thread toInterrupt, String taskName, Long timeout)` Checks whether the task should be interrupted during cancellation and if so, execute the specified `Runnable interruptAction`.
`Future<Void>`	`notifyCheckpointAbortAsync(long checkpointId, long latestCompletedCheckpointId)` Invoked when a checkpoint has been aborted, i.e., when the checkpoint coordinator has received a decline message from one task and try to abort the targeted checkpoint by notification.
`Future<Void>`	`notifyCheckpointCompleteAsync(long checkpointId)` Invoked when a checkpoint has been completed, i.e., when the checkpoint coordinator has received the notification from all participating tasks.
`void`	`restore()` This method can be called before `TaskInvokable.invoke()` to restore an invokable object for the last valid state, if it has it.
`CompletableFuture<Boolean>`	`triggerCheckpointAsync(CheckpointMetaData checkpointMetaData, CheckpointOptions checkpointOptions)` This method is called to trigger a checkpoint, asynchronously by the checkpoint coordinator.
`void`	`triggerCheckpointOnBarrier(CheckpointMetaData checkpointMetaData, CheckpointOptions checkpointOptions, CheckpointMetricsBuilder checkpointMetrics)` This method is called when a checkpoint is triggered as a result of receiving checkpoint barriers on all input streams.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AbstractInvokable
```
public AbstractInvokable(Environment environment)
```
    Create an Invokable task and set its environment.
    
    参数:
    
    environment - The environment assigned to this invokable.
- 方法详细资料
  - invoke
```
public abstract void invoke()
                     throws Exception
```
    从接口复制的说明: TaskInvokable
    
    Starts the execution.
    This method is called by the task manager when the actual execution of the task starts.
    All resources should be cleaned up by calling TaskInvokable.cleanUp(Throwable) ()} after the method returns.
    
    指定者:
    
    invoke 在接口中 TaskInvokable
    
    抛出:
    
    Exception
  - cancel
```
public Future<Void> cancel()
                    throws Exception
```
    从接口复制的说明: TaskInvokable
    
    This method is called when a task is canceled either as a result of a user abort or an execution failure. It can be overwritten to respond to shut down the user code properly.
    
    指定者:
    
    cancel 在接口中 TaskInvokable
    
    返回:
    
    a future that is completed when this AbstractInvokable is fully terminated. Note that it may never complete if the invokable is stuck.
    
    抛出:
    
    Exception
  - cleanUp
```
public void cleanUp(@Nullable
                    Throwable throwable)
             throws Exception
```
    从接口复制的说明: TaskInvokable
    
    Cleanup any resources used in TaskInvokable.invoke() OR TaskInvokable.restore(). This method must be called regardless whether the aforementioned calls succeeded or failed.
    
    指定者:
    
    cleanUp 在接口中 TaskInvokable
    
    参数:
    
    throwable - iff failure happened during the execution of TaskInvokable.restore() or TaskInvokable.invoke(), null otherwise.
    ATTENTION: CancelTaskException should not be treated as a failure.
    
    抛出:
    
    Exception
  - maybeInterruptOnCancel
```
public void maybeInterruptOnCancel(Thread toInterrupt,
                                   @Nullable
                                   String taskName,
                                   @Nullable
                                   Long timeout)
```
    从接口复制的说明: TaskInvokable
    
    Checks whether the task should be interrupted during cancellation and if so, execute the specified Runnable interruptAction.
    
    指定者:
    
    maybeInterruptOnCancel 在接口中 TaskInvokable
    
    taskName - optional taskName to log stack trace
    
    timeout - optional timeout to log stack trace
  - getEnvironment
```
public final Environment getEnvironment()
```
    Returns the environment of this task.
    
    返回:
    
    The environment of this task.
  - getUserCodeClassLoader
```
public final ClassLoader getUserCodeClassLoader()
```
    Returns the user code class loader of this invokable.
    
    返回:
    
    user code class loader of this invokable.
  - getCurrentNumberOfSubtasks
```
public int getCurrentNumberOfSubtasks()
```
    Returns the current number of subtasks the respective task is split into.
    
    返回:
    
    the current number of subtasks the respective task is split into
  - getIndexInSubtaskGroup
```
public int getIndexInSubtaskGroup()
```
    Returns the index of this subtask in the subtask group.
    
    返回:
    
    the index of this subtask in the subtask group
  - getTaskConfiguration
```
public final org.apache.flink.configuration.Configuration getTaskConfiguration()
```
    Returns the task configuration object which was attached to the original JobVertex.
    
    返回:
    
    the task configuration object which was attached to the original JobVertex
  - getJobConfiguration
```
public org.apache.flink.configuration.Configuration getJobConfiguration()
```
    Returns the job configuration object which was attached to the original JobGraph.
    
    返回:
    
    the job configuration object which was attached to the original JobGraph
  - getExecutionConfig
```
public org.apache.flink.api.common.ExecutionConfig getExecutionConfig()
```
    Returns the global ExecutionConfig.
  - triggerCheckpointAsync
```
public CompletableFuture<Boolean> triggerCheckpointAsync(CheckpointMetaData checkpointMetaData,
                                                         CheckpointOptions checkpointOptions)
```
    从接口复制的说明: CheckpointableTask
    
    This method is called to trigger a checkpoint, asynchronously by the checkpoint coordinator.
    This method is called for tasks that start the checkpoints by injecting the initial barriers, i.e., the source tasks. In contrast, checkpoints on downstream operators, which are the result of receiving checkpoint barriers, invoke the CheckpointableTask.triggerCheckpointOnBarrier(CheckpointMetaData, CheckpointOptions, CheckpointMetricsBuilder) method.
    
    指定者:
    
    triggerCheckpointAsync 在接口中 CheckpointableTask
    
    参数:
    
    checkpointMetaData - Meta data for about this checkpoint
    
    checkpointOptions - Options for performing this checkpoint
    
    返回:
    
    future with value of false if the checkpoint was not carried out, true otherwise
  - triggerCheckpointOnBarrier
```
public void triggerCheckpointOnBarrier(CheckpointMetaData checkpointMetaData,
                                       CheckpointOptions checkpointOptions,
                                       CheckpointMetricsBuilder checkpointMetrics)
                                throws IOException
```
    从接口复制的说明: CheckpointableTask
    
    This method is called when a checkpoint is triggered as a result of receiving checkpoint barriers on all input streams.
    
    指定者:
    
    triggerCheckpointOnBarrier 在接口中 CheckpointableTask
    
    参数:
    
    checkpointMetaData - Meta data for about this checkpoint
    
    checkpointOptions - Options for performing this checkpoint
    
    checkpointMetrics - Metrics about this checkpoint
    
    抛出:
    
    IOException - Exceptions thrown as the result of triggering a checkpoint are forwarded.
  - abortCheckpointOnBarrier
```
public void abortCheckpointOnBarrier(long checkpointId,
                                     CheckpointException cause)
                              throws IOException
```
    从接口复制的说明: CheckpointableTask
    
    Aborts a checkpoint as the result of receiving possibly some checkpoint barriers, but at least one CancelCheckpointMarker.
    This requires implementing tasks to forward a CancelCheckpointMarker to their outputs.
    
    指定者:
    
    abortCheckpointOnBarrier 在接口中 CheckpointableTask
    
    参数:
    
    checkpointId - The ID of the checkpoint to be aborted.
    
    cause - The reason why the checkpoint was aborted during alignment
    
    抛出:
    
    IOException
  - notifyCheckpointCompleteAsync
```
public Future<Void> notifyCheckpointCompleteAsync(long checkpointId)
```
    从接口复制的说明: CheckpointableTask
    
    Invoked when a checkpoint has been completed, i.e., when the checkpoint coordinator has received the notification from all participating tasks.
    
    指定者:
    
    notifyCheckpointCompleteAsync 在接口中 CheckpointableTask
    
    参数:
    
    checkpointId - The ID of the checkpoint that is complete.
    
    返回:
    
    future that completes when the notification has been processed by the task.
  - notifyCheckpointAbortAsync
```
public Future<Void> notifyCheckpointAbortAsync(long checkpointId,
                                               long latestCompletedCheckpointId)
```
    从接口复制的说明: CheckpointableTask
    
    Invoked when a checkpoint has been aborted, i.e., when the checkpoint coordinator has received a decline message from one task and try to abort the targeted checkpoint by notification.
    
    指定者:
    
    notifyCheckpointAbortAsync 在接口中 CheckpointableTask
    
    参数:
    
    checkpointId - The ID of the checkpoint that is aborted.
    
    latestCompletedCheckpointId - The ID of the latest completed checkpoint.
    
    返回:
    
    future that completes when the notification has been processed by the task.
  - dispatchOperatorEvent
```
public void dispatchOperatorEvent(OperatorID operator,
                                  org.apache.flink.util.SerializedValue<OperatorEvent> event)
                           throws org.apache.flink.util.FlinkException
```
    指定者:
    
    dispatchOperatorEvent 在接口中 CoordinatedTask
    
    抛出:
    
    org.apache.flink.util.FlinkException
  - restore
```
public void restore()
             throws Exception
```
    从接口复制的说明: TaskInvokable
    
    This method can be called before TaskInvokable.invoke() to restore an invokable object for the last valid state, if it has it.
    If TaskInvokable.invoke() is not called after this method for some reason (e.g. task cancellation); then all resources should be cleaned up by calling TaskInvokable.cleanUp(Throwable) ()} after the method returns.
    
    指定者:
    
    restore 在接口中 TaskInvokable
    
    抛出:
    
    Exception
  - isUsingNonBlockingInput
```
public boolean isUsingNonBlockingInput()
```
    指定者:
    
    isUsingNonBlockingInput 在接口中 TaskInvokable
    
    返回:
    
    true if blocking input such as InputGate.getNext() is used (as opposed to InputGate.pollNext(). To be removed together with the DataSet API.

类 AbstractInvokable

构造器概要

方法概要

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

构造器详细资料

AbstractInvokable

方法详细资料

invoke

cancel

cleanUp

maybeInterruptOnCancel

getEnvironment

getUserCodeClassLoader

getCurrentNumberOfSubtasks

getIndexInSubtaskGroup

getTaskConfiguration

getJobConfiguration

getExecutionConfig

triggerCheckpointAsync

triggerCheckpointOnBarrier

abortCheckpointOnBarrier

notifyCheckpointCompleteAsync

notifyCheckpointAbortAsync

dispatchOperatorEvent

restore

isUsingNonBlockingInput