org.apache.flink.runtime.execution

Interface Environment

All Known Implementing Classes:

RuntimeEnvironment

public interface Environment

The Environment gives the code executed in a task access to the task's properties (such as name, parallelism), the configurations, the data stream readers and writers, as well as the various components that are provided by the TaskManager, such as memory manager, I/O manager, ...

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.
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.
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 (getIndexInSubtaskGroup() + 1), and 6 would be getNumberOfSubtasks().
ClassLoader	getUserClassLoader() Returns the user code class loader
ResultPartitionWriter	getWriter(int index)
void	reportAccumulators(Map<String,org.apache.flink.api.common.accumulators.Accumulator<?,?>> accumulators) Reports the given set of accumulators to the JobManager.

Method Detail

getJobID

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

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

Returns:

the ID of the job from the original job graph

getJobVertexId

JobVertexID getJobVertexId()

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

Returns:

The JobVertexID of this task.

getExecutionId

ExecutionAttemptID getExecutionId()

Gets the ID of the task execution attempt.

Returns:

The ID of the task execution attempt.

getTaskConfiguration

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

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

Returns:

The task-wide configuration

getJobConfiguration

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

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

Returns:

The job-wide configuration

getNumberOfSubtasks

int getNumberOfSubtasks()

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

Returns:

the current number of subtasks the respective task is split into

getIndexInSubtaskGroup

int getIndexInSubtaskGroup()

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

Returns:

the index of this subtask in the subtask group

getInputSplitProvider

InputSplitProvider getInputSplitProvider()

Returns the input split provider assigned to this environment.

Returns:

The input split provider or null if no such provider has been assigned to this environment.

getIOManager

IOManager getIOManager()

Returns the current IOManager.

Returns:

the current IOManager.

getMemoryManager

MemoryManager getMemoryManager()

Returns the current MemoryManager.

Returns:

the current MemoryManager.

getTaskName

String getTaskName()

Returns the name of the task running in this environment.

Returns:

the name of the task running in this environment

getTaskNameWithSubtasks

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 (getIndexInSubtaskGroup() + 1), and 6 would be getNumberOfSubtasks().

Returns:

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

getUserClassLoader

ClassLoader getUserClassLoader()

Returns the user code class loader

getDistributedCacheEntries

Map<String,Future<org.apache.flink.core.fs.Path>> getDistributedCacheEntries()

getBroadcastVariableManager

BroadcastVariableManager getBroadcastVariableManager()

reportAccumulators

void reportAccumulators(Map<String,org.apache.flink.api.common.accumulators.Accumulator<?,?>> accumulators)

Reports the given set of accumulators to the JobManager.

Parameters:

accumulators - The accumulators to report.

acknowledgeCheckpoint

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. This method does not include any state in the checkpoint.

Parameters:

checkpointId - The ID of the checkpoint.

acknowledgeCheckpoint

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. This method does include the given state in the checkpoint.

Parameters:

checkpointId - The ID of the checkpoint.

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

getWriter

ResultPartitionWriter getWriter(int index)

getAllWriters

ResultPartitionWriter[] getAllWriters()

getInputGate

InputGate getInputGate(int index)

getAllInputGates

InputGate[] getAllInputGates()