RuntimeEnvironment (Flink : Runtime 1.16.3 API)

java.lang.Object
- org.apache.flink.runtime.taskmanager.RuntimeEnvironment

所有已实现的接口:: Environment

public class RuntimeEnvironment
extends Object
implements Environment

In implementation of the Environment.

构造器概要

构造器
构造器和说明
RuntimeEnvironment(org.apache.flink.api.common.JobID jobId, JobVertexID jobVertexId, ExecutionAttemptID executionId, org.apache.flink.api.common.ExecutionConfig executionConfig, org.apache.flink.api.common.TaskInfo taskInfo, org.apache.flink.configuration.Configuration jobConfiguration, org.apache.flink.configuration.Configuration taskConfiguration, org.apache.flink.util.UserCodeClassLoader userCodeClassLoader, MemoryManager memManager, IOManager ioManager, BroadcastVariableManager bcVarManager, TaskStateManager taskStateManager, GlobalAggregateManager aggregateManager, AccumulatorRegistry accumulatorRegistry, TaskKvStateRegistry kvStateRegistry, InputSplitProvider splitProvider, Map<String,Future<org.apache.flink.core.fs.Path>> distCacheEntries, ResultPartitionWriter[] writers, IndexedInputGate[] inputGates, TaskEventDispatcher taskEventDispatcher, CheckpointResponder checkpointResponder, TaskOperatorEventGateway operatorEventGateway, TaskManagerRuntimeInfo taskManagerInfo, TaskMetricGroup metrics, Task containingTask, ExternalResourceInfoProvider externalResourceInfoProvider)

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`acknowledgeCheckpoint(long checkpointId, CheckpointMetrics checkpointMetrics)` Confirms that the invokable has successfully completed all steps it needed to to for the checkpoint with the give checkpoint-ID.
`void`	`acknowledgeCheckpoint(long checkpointId, CheckpointMetrics checkpointMetrics, TaskStateSnapshot checkpointStateHandles)` Confirms that the invokable has successfully completed all required steps for the checkpoint with the give checkpoint-ID.
`void`	`declineCheckpoint(long checkpointId, CheckpointException checkpointException)` Declines a checkpoint.
`void`	`failExternally(Throwable cause)` Marks task execution failed for an external reason (a reason other than the task code itself throwing an exception).
`AccumulatorRegistry`	`getAccumulatorRegistry()` Return the registry for accumulators which are periodically sent to the job manager.
`IndexedInputGate[]`	`getAllInputGates()`
`ResultPartitionWriter[]`	`getAllWriters()`
`ExecutorService`	`getAsyncOperationsThreadPool()`
`BroadcastVariableManager`	`getBroadcastVariableManager()`
`CheckpointStorageAccess`	`getCheckpointStorageAccess()`
`Map<String,Future<org.apache.flink.core.fs.Path>>`	`getDistributedCacheEntries()`
`org.apache.flink.api.common.ExecutionConfig`	`getExecutionConfig()` Returns the job specific `ExecutionConfig`.
`ExecutionAttemptID`	`getExecutionId()` Gets the ID of the task execution attempt.
`ExternalResourceInfoProvider`	`getExternalResourceInfoProvider()` Get the `ExternalResourceInfoProvider` which contains infos of available external resources.
`GlobalAggregateManager`	`getGlobalAggregateManager()`
`IndexedInputGate`	`getInputGate(int index)`
`InputSplitProvider`	`getInputSplitProvider()` Returns the input split provider assigned to this environment.
`IOManager`	`getIOManager()` Returns the current `IOManager`.
`org.apache.flink.configuration.Configuration`	`getJobConfiguration()` Returns the job-wide configuration object that was attached to the JobGraph.
`org.apache.flink.api.common.JobID`	`getJobID()` Returns the ID of the job that the task belongs to.
`JobVertexID`	`getJobVertexId()` Gets the ID of the JobVertex for which this task executes a parallel subtask.
`org.apache.flink.api.common.operators.MailboxExecutor`	`getMainMailboxExecutor()`
`MemoryManager`	`getMemoryManager()` Returns the current `MemoryManager`.
`TaskMetricGroup`	`getMetricGroup()` Returns the task specific metric group.
`TaskOperatorEventGateway`	`getOperatorCoordinatorEventGateway()` Gets the gateway through which operators can send events to the operator coordinators.
`org.apache.flink.configuration.Configuration`	`getTaskConfiguration()` Returns the task-wide configuration object, originally attached to the job vertex.
`TaskEventDispatcher`	`getTaskEventDispatcher()`
`org.apache.flink.api.common.TaskInfo`	`getTaskInfo()` Returns the `TaskInfo` object associated with this subtask
`TaskKvStateRegistry`	`getTaskKvStateRegistry()` Returns the registry for `InternalKvState` instances.
`TaskManagerRuntimeInfo`	`getTaskManagerInfo()` Gets the task manager info, with configuration and hostname.
`TaskStateManager`	`getTaskStateManager()`
`org.apache.flink.util.UserCodeClassLoader`	`getUserCodeClassLoader()` Returns the user code class loader
`ResultPartitionWriter`	`getWriter(int index)`
`void`	`setAsyncOperationsThreadPool(ExecutorService executorService)`
`void`	`setCheckpointStorageAccess(CheckpointStorageAccess checkpointStorageAccess)`
`void`	`setMainMailboxExecutor(org.apache.flink.api.common.operators.MailboxExecutor mainMailboxExecutor)`

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

- 构造器详细资料
  - RuntimeEnvironment
```
public RuntimeEnvironment(org.apache.flink.api.common.JobID jobId,
                          JobVertexID jobVertexId,
                          ExecutionAttemptID executionId,
                          org.apache.flink.api.common.ExecutionConfig executionConfig,
                          org.apache.flink.api.common.TaskInfo taskInfo,
                          org.apache.flink.configuration.Configuration jobConfiguration,
                          org.apache.flink.configuration.Configuration taskConfiguration,
                          org.apache.flink.util.UserCodeClassLoader userCodeClassLoader,
                          MemoryManager memManager,
                          IOManager ioManager,
                          BroadcastVariableManager bcVarManager,
                          TaskStateManager taskStateManager,
                          GlobalAggregateManager aggregateManager,
                          AccumulatorRegistry accumulatorRegistry,
                          TaskKvStateRegistry kvStateRegistry,
                          InputSplitProvider splitProvider,
                          Map<String,Future<org.apache.flink.core.fs.Path>> distCacheEntries,
                          ResultPartitionWriter[] writers,
                          IndexedInputGate[] inputGates,
                          TaskEventDispatcher taskEventDispatcher,
                          CheckpointResponder checkpointResponder,
                          TaskOperatorEventGateway operatorEventGateway,
                          TaskManagerRuntimeInfo taskManagerInfo,
                          TaskMetricGroup metrics,
                          Task containingTask,
                          ExternalResourceInfoProvider externalResourceInfoProvider)
```
- 方法详细资料
  - getExecutionConfig
```
public org.apache.flink.api.common.ExecutionConfig getExecutionConfig()
```
    从接口复制的说明: Environment
    
    Returns the job specific ExecutionConfig.
    
    指定者:
    
    getExecutionConfig 在接口中 Environment
    
    返回:
    
    The execution configuration associated with the current job.
  - getJobID
```
public org.apache.flink.api.common.JobID getJobID()
```
    从接口复制的说明: Environment
    
    Returns the ID of the job that the task belongs to.
    
    指定者:
    
    getJobID 在接口中 Environment
    
    返回:
    
    the ID of the job from the original job graph
  - getJobVertexId
```
public JobVertexID getJobVertexId()
```
    从接口复制的说明: Environment
    
    Gets the ID of the JobVertex for which this task executes a parallel subtask.
    
    指定者:
    
    getJobVertexId 在接口中 Environment
    
    返回:
    
    The JobVertexID of this task.
  - getExecutionId
```
public ExecutionAttemptID getExecutionId()
```
    从接口复制的说明: Environment
    
    Gets the ID of the task execution attempt.
    
    指定者:
    
    getExecutionId 在接口中 Environment
    
    返回:
    
    The ID of the task execution attempt.
  - getTaskInfo
```
public org.apache.flink.api.common.TaskInfo getTaskInfo()
```
    从接口复制的说明: Environment
    
    Returns the TaskInfo object associated with this subtask
    
    指定者:
    
    getTaskInfo 在接口中 Environment
    
    返回:
    
    TaskInfo for this subtask
  - getJobConfiguration
```
public org.apache.flink.configuration.Configuration getJobConfiguration()
```
    从接口复制的说明: Environment
    
    Returns the job-wide configuration object that was attached to the JobGraph.
    
    指定者:
    
    getJobConfiguration 在接口中 Environment
    
    返回:
    
    The job-wide configuration
  - getTaskConfiguration
```
public org.apache.flink.configuration.Configuration getTaskConfiguration()
```
    从接口复制的说明: Environment
    
    Returns the task-wide configuration object, originally attached to the job vertex.
    
    指定者:
    
    getTaskConfiguration 在接口中 Environment
    
    返回:
    
    The task-wide configuration
  - getTaskManagerInfo
```
public TaskManagerRuntimeInfo getTaskManagerInfo()
```
    从接口复制的说明: Environment
    
    Gets the task manager info, with configuration and hostname.
    
    指定者:
    
    getTaskManagerInfo 在接口中 Environment
    
    返回:
    
    The task manager info, with configuration and hostname.
  - getMetricGroup
```
public TaskMetricGroup getMetricGroup()
```
    从接口复制的说明: Environment
    
    Returns the task specific metric group.
    
    指定者:
    
    getMetricGroup 在接口中 Environment
    
    返回:
    
    The MetricGroup of this task.
  - getUserCodeClassLoader
```
public org.apache.flink.util.UserCodeClassLoader getUserCodeClassLoader()
```
    从接口复制的说明: Environment
    
    Returns the user code class loader
    
    指定者:
    
    getUserCodeClassLoader 在接口中 Environment
  - getMemoryManager
```
public MemoryManager getMemoryManager()
```
    从接口复制的说明: Environment
    
    Returns the current MemoryManager.
    
    指定者:
    
    getMemoryManager 在接口中 Environment
    
    返回:
    
    the current MemoryManager.
  - getIOManager
```
public IOManager getIOManager()
```
    从接口复制的说明: Environment
    
    Returns the current IOManager.
    
    指定者:
    
    getIOManager 在接口中 Environment
    
    返回:
    
    the current IOManager.
  - getBroadcastVariableManager
```
public BroadcastVariableManager getBroadcastVariableManager()
```
    指定者:
    
    getBroadcastVariableManager 在接口中 Environment
  - getTaskStateManager
```
public TaskStateManager getTaskStateManager()
```
    指定者:
    
    getTaskStateManager 在接口中 Environment
  - getGlobalAggregateManager
```
public GlobalAggregateManager getGlobalAggregateManager()
```
    指定者:
    
    getGlobalAggregateManager 在接口中 Environment
  - getAccumulatorRegistry
```
public AccumulatorRegistry getAccumulatorRegistry()
```
    从接口复制的说明: Environment
    
    Return the registry for accumulators which are periodically sent to the job manager.
    
    指定者:
    
    getAccumulatorRegistry 在接口中 Environment
    
    返回:
    
    the registry
  - getTaskKvStateRegistry
```
public TaskKvStateRegistry getTaskKvStateRegistry()
```
    从接口复制的说明: Environment
    
    Returns the registry for InternalKvState instances.
    
    指定者:
    
    getTaskKvStateRegistry 在接口中 Environment
    
    返回:
    
    KvState registry
  - getInputSplitProvider
```
public InputSplitProvider getInputSplitProvider()
```
    从接口复制的说明: Environment
    
    Returns the input split provider assigned to this environment.
    
    指定者:
    
    getInputSplitProvider 在接口中 Environment
    
    返回:
    
    The input split provider or null if no such provider has been assigned to this environment.
  - getDistributedCacheEntries
```
public Map<String,Future<org.apache.flink.core.fs.Path>> getDistributedCacheEntries()
```
    指定者:
    
    getDistributedCacheEntries 在接口中 Environment
  - getWriter
```
public ResultPartitionWriter getWriter(int index)
```
    指定者:
    
    getWriter 在接口中 Environment
  - getAllWriters
```
public ResultPartitionWriter[] getAllWriters()
```
    指定者:
    
    getAllWriters 在接口中 Environment
  - getInputGate
```
public IndexedInputGate getInputGate(int index)
```
    指定者:
    
    getInputGate 在接口中 Environment
  - getAllInputGates
```
public IndexedInputGate[] getAllInputGates()
```
    指定者:
    
    getAllInputGates 在接口中 Environment
  - getTaskEventDispatcher
```
public TaskEventDispatcher getTaskEventDispatcher()
```
    指定者:
    
    getTaskEventDispatcher 在接口中 Environment
  - getExternalResourceInfoProvider
```
public ExternalResourceInfoProvider getExternalResourceInfoProvider()
```
    从接口复制的说明: Environment
    
    Get the ExternalResourceInfoProvider which contains infos of available external resources.
    
    指定者:
    
    getExternalResourceInfoProvider 在接口中 Environment
    
    返回:
    
    ExternalResourceInfoProvider which contains infos of available external resources
  - acknowledgeCheckpoint
```
public void acknowledgeCheckpoint(long checkpointId,
                                  CheckpointMetrics checkpointMetrics)
```
    从接口复制的说明: Environment
    
    Confirms that the invokable has successfully completed all steps it needed to to for the checkpoint with the give checkpoint-ID. This method does not include any state in the checkpoint.
    
    指定者:
    
    acknowledgeCheckpoint 在接口中 Environment
    
    参数:
    
    checkpointId - ID of this checkpoint
    
    checkpointMetrics - metrics for this checkpoint
  - acknowledgeCheckpoint
```
public void acknowledgeCheckpoint(long checkpointId,
                                  CheckpointMetrics checkpointMetrics,
                                  TaskStateSnapshot checkpointStateHandles)
```
    从接口复制的说明: Environment
    
    Confirms that the invokable has successfully completed all required steps for the checkpoint with the give checkpoint-ID. This method does include the given state in the checkpoint.
    
    指定者:
    
    acknowledgeCheckpoint 在接口中 Environment
    
    参数:
    
    checkpointId - ID of this checkpoint
    
    checkpointMetrics - metrics for this checkpoint
    
    checkpointStateHandles - All state handles for the checkpointed state
  - declineCheckpoint
```
public void declineCheckpoint(long checkpointId,
                              CheckpointException checkpointException)
```
    从接口复制的说明: Environment
    
    Declines a checkpoint. This tells the checkpoint coordinator that this task will not be able to successfully complete a certain checkpoint.
    
    指定者:
    
    declineCheckpoint 在接口中 Environment
    
    参数:
    
    checkpointId - The ID of the declined checkpoint.
    
    checkpointException - The exception why the checkpoint was declined.
  - getOperatorCoordinatorEventGateway
```
public TaskOperatorEventGateway getOperatorCoordinatorEventGateway()
```
    从接口复制的说明: Environment
    
    Gets the gateway through which operators can send events to the operator coordinators.
    
    指定者:
    
    getOperatorCoordinatorEventGateway 在接口中 Environment
  - failExternally
```
public void failExternally(Throwable cause)
```
    从接口复制的说明: Environment
    
    Marks task execution failed for an external reason (a reason other than the task code itself throwing an exception). If the task is already in a terminal state (such as FINISHED, CANCELED, FAILED), or if the task is already canceling this does nothing. Otherwise it sets the state to FAILED, and, if the invokable code is running, starts an asynchronous thread that aborts that code.
    This method never blocks.
    
    指定者:
    
    failExternally 在接口中 Environment
  - setMainMailboxExecutor
```
public void setMainMailboxExecutor(org.apache.flink.api.common.operators.MailboxExecutor mainMailboxExecutor)
```
    指定者:
    
    setMainMailboxExecutor 在接口中 Environment
  - getMainMailboxExecutor
```
public org.apache.flink.api.common.operators.MailboxExecutor getMainMailboxExecutor()
```
    指定者:
    
    getMainMailboxExecutor 在接口中 Environment
  - setAsyncOperationsThreadPool
```
public void setAsyncOperationsThreadPool(ExecutorService executorService)
```
    指定者:
    
    setAsyncOperationsThreadPool 在接口中 Environment
  - getAsyncOperationsThreadPool
```
public ExecutorService getAsyncOperationsThreadPool()
```
    指定者:
    
    getAsyncOperationsThreadPool 在接口中 Environment
  - setCheckpointStorageAccess
```
public void setCheckpointStorageAccess(CheckpointStorageAccess checkpointStorageAccess)
```
    指定者:
    
    setCheckpointStorageAccess 在接口中 Environment
  - getCheckpointStorageAccess
```
public CheckpointStorageAccess getCheckpointStorageAccess()
```
    指定者:
    
    getCheckpointStorageAccess 在接口中 Environment

类 RuntimeEnvironment

构造器概要

方法概要

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

构造器详细资料

RuntimeEnvironment

方法详细资料

getExecutionConfig

getJobID

getJobVertexId

getExecutionId

getTaskInfo

getJobConfiguration

getTaskConfiguration

getTaskManagerInfo

getMetricGroup

getUserCodeClassLoader

getMemoryManager

getIOManager

getBroadcastVariableManager

getTaskStateManager

getGlobalAggregateManager

getAccumulatorRegistry

getTaskKvStateRegistry

getInputSplitProvider

getDistributedCacheEntries

getWriter

getAllWriters

getInputGate

getAllInputGates

getTaskEventDispatcher

getExternalResourceInfoProvider

acknowledgeCheckpoint

acknowledgeCheckpoint

declineCheckpoint

getOperatorCoordinatorEventGateway

failExternally

setMainMailboxExecutor

getMainMailboxExecutor

setAsyncOperationsThreadPool

getAsyncOperationsThreadPool

setCheckpointStorageAccess

getCheckpointStorageAccess