org.apache.flink.runtime.taskmanager

Class RuntimeEnvironment

java.lang.Object

org.apache.flink.runtime.taskmanager.RuntimeEnvironment

All Implemented Interfaces:

Environment

public class RuntimeEnvironment
extends Object
implements Environment

In implementation of the Environment.

Constructor Summary

Constructors

Constructor and Description

RuntimeEnvironment(org.apache.flink.api.common.JobID jobId, JobVertexID jobVertexId, ExecutionAttemptID executionId, String taskName, String taskNameWithSubtasks, int subtaskIndex, int parallelism, org.apache.flink.configuration.Configuration jobConfiguration, org.apache.flink.configuration.Configuration taskConfiguration, ClassLoader userCodeClassLoader, MemoryManager memManager, IOManager ioManager, BroadcastVariableManager bcVarManager, AccumulatorRegistry accumulatorRegistry, InputSplitProvider splitProvider, Map<String,Future<org.apache.flink.core.fs.Path>> distCacheEntries, ResultPartitionWriter[] writers, InputGate[] inputGates, ActorGateway jobManager, TaskManagerRuntimeInfo taskManagerInfo)

Method Summary

Modifier and Type	Method and Description
void	acknowledgeCheckpoint(long checkpointId) 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, StateHandle<?> state) Confirms that the invokable has successfully completed all steps it needed to to for the checkpoint with the give checkpoint-ID.
AccumulatorRegistry	getAccumulatorRegistry() Return the registry for accumulators which are periodically sent to the job manager.
InputGate[]	getAllInputGates()
ResultPartitionWriter[]	getAllWriters()
BroadcastVariableManager	getBroadcastVariableManager()
Map<String,Future<org.apache.flink.core.fs.Path>>	getDistributedCacheEntries()
ExecutionAttemptID	getExecutionId() Gets the ID of the task execution attempt.
int	getIndexInSubtaskGroup() Returns the index of this subtask in the subtask group.
InputGate	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.
MemoryManager	getMemoryManager() Returns the current MemoryManager.
int	getNumberOfSubtasks() Returns the current number of subtasks the respective task is split into.
org.apache.flink.configuration.Configuration	getTaskConfiguration() Returns the task-wide configuration object, originally attache to the job vertex.
TaskManagerRuntimeInfo	getTaskManagerInfo() Gets the task manager info, with configuration and hostname.
String	getTaskName() Returns the name of the task running in this environment.
String	getTaskNameWithSubtasks() Returns the name of the task running in this environment, appended with the subtask indicator, such as "MyTask (3/6)", where 3 would be (Environment.getIndexInSubtaskGroup() + 1), and 6 would be Environment.getNumberOfSubtasks().
ClassLoader	getUserClassLoader() Returns the user code class loader
ResultPartitionWriter	getWriter(int index)

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimeEnvironment

public RuntimeEnvironment(org.apache.flink.api.common.JobID jobId,
                          JobVertexID jobVertexId,
                          ExecutionAttemptID executionId,
                          String taskName,
                          String taskNameWithSubtasks,
                          int subtaskIndex,
                          int parallelism,
                          org.apache.flink.configuration.Configuration jobConfiguration,
                          org.apache.flink.configuration.Configuration taskConfiguration,
                          ClassLoader userCodeClassLoader,
                          MemoryManager memManager,
                          IOManager ioManager,
                          BroadcastVariableManager bcVarManager,
                          AccumulatorRegistry accumulatorRegistry,
                          InputSplitProvider splitProvider,
                          Map<String,Future<org.apache.flink.core.fs.Path>> distCacheEntries,
                          ResultPartitionWriter[] writers,
                          InputGate[] inputGates,
                          ActorGateway jobManager,
                          TaskManagerRuntimeInfo taskManagerInfo)

Method Detail

getJobID

public org.apache.flink.api.common.JobID getJobID()

Description copied from interface: Environment

Returns the ID of the job that the task belongs to.

Specified by:

getJobID in interface Environment

Returns:

the ID of the job from the original job graph

getJobVertexId

public JobVertexID getJobVertexId()

Description copied from interface: Environment

Gets the ID of the JobVertex for which this task executes a parallel subtask.

Specified by:

getJobVertexId in interface Environment

Returns:

The JobVertexID of this task.

getExecutionId

public ExecutionAttemptID getExecutionId()

Description copied from interface: Environment

Gets the ID of the task execution attempt.

Specified by:

getExecutionId in interface Environment

Returns:

The ID of the task execution attempt.

getTaskName

public String getTaskName()

Description copied from interface: Environment

Returns the name of the task running in this environment.

Specified by:

getTaskName in interface Environment

Returns:

the name of the task running in this environment

getTaskNameWithSubtasks

public String getTaskNameWithSubtasks()

Description copied from interface: Environment

Returns the name of the task running in this environment, appended with the subtask indicator, such as "MyTask (3/6)", where 3 would be (Environment.getIndexInSubtaskGroup() + 1), and 6 would be Environment.getNumberOfSubtasks().

Specified by:

getTaskNameWithSubtasks in interface Environment

Returns:

The name of the task running in this environment, with subtask indicator.

getNumberOfSubtasks

public int getNumberOfSubtasks()

Description copied from interface: Environment

Returns the current number of subtasks the respective task is split into.

Specified by:

getNumberOfSubtasks in interface Environment

Returns:

the current number of subtasks the respective task is split into

getIndexInSubtaskGroup

public int getIndexInSubtaskGroup()

Description copied from interface: Environment

Returns the index of this subtask in the subtask group. The index is between 0 and Environment.getNumberOfSubtasks() - 1.

Specified by:

getIndexInSubtaskGroup in interface Environment

Returns:

the index of this subtask in the subtask group

getJobConfiguration

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

Description copied from interface: Environment

Returns the job-wide configuration object that was attached to the JobGraph.

Specified by:

getJobConfiguration in interface Environment

Returns:

The job-wide configuration

getTaskConfiguration

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

Description copied from interface: Environment

Returns the task-wide configuration object, originally attache to the job vertex.

Specified by:

getTaskConfiguration in interface Environment

Returns:

The task-wide configuration

getTaskManagerInfo

public TaskManagerRuntimeInfo getTaskManagerInfo()

Description copied from interface: Environment

Gets the task manager info, with configuration and hostname.

Specified by:

getTaskManagerInfo in interface Environment

Returns:

The task manager info, with configuration and hostname.

getUserClassLoader

public ClassLoader getUserClassLoader()

Description copied from interface: Environment

Returns the user code class loader

Specified by:

getUserClassLoader in interface Environment

getMemoryManager

public MemoryManager getMemoryManager()

Description copied from interface: Environment

Returns the current MemoryManager.

Specified by:

getMemoryManager in interface Environment

Returns:

the current MemoryManager.

getIOManager

public IOManager getIOManager()

Description copied from interface: Environment

Returns the current IOManager.

Specified by:

getIOManager in interface Environment

Returns:

the current IOManager.

getBroadcastVariableManager

public BroadcastVariableManager getBroadcastVariableManager()

Specified by:

getBroadcastVariableManager in interface Environment

getAccumulatorRegistry

public AccumulatorRegistry getAccumulatorRegistry()

Description copied from interface: Environment

Return the registry for accumulators which are periodically sent to the job manager.

Specified by:

getAccumulatorRegistry in interface Environment

Returns:

the registry

getInputSplitProvider

public InputSplitProvider getInputSplitProvider()

Description copied from interface: Environment

Returns the input split provider assigned to this environment.

Specified by:

getInputSplitProvider in interface Environment

Returns:

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()

Specified by:

getDistributedCacheEntries in interface Environment

getWriter

public ResultPartitionWriter getWriter(int index)

Specified by:

getWriter in interface Environment

getAllWriters

public ResultPartitionWriter[] getAllWriters()

Specified by:

getAllWriters in interface Environment

getInputGate

public InputGate getInputGate(int index)

Specified by:

getInputGate in interface Environment

getAllInputGates

public InputGate[] getAllInputGates()

Specified by:

getAllInputGates in interface Environment

acknowledgeCheckpoint

public void acknowledgeCheckpoint(long checkpointId)

Description copied from interface: 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.

Specified by:

acknowledgeCheckpoint in interface Environment

Parameters:

checkpointId - The ID of the checkpoint.

acknowledgeCheckpoint

public void acknowledgeCheckpoint(long checkpointId,
                                  StateHandle<?> state)

Description copied from interface: 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 include the given state in the checkpoint.

Specified by:

acknowledgeCheckpoint in interface Environment

Parameters:

checkpointId - The ID of the checkpoint.

state - A handle to the state to be included in the checkpoint.