org.apache.flink.runtime.taskmanager

Class Task

java.lang.Object

org.apache.flink.runtime.taskmanager.Task

public final class Task
extends Object

Constructor Summary

Constructors

Constructor and Description
Task(JobID jobId, JobVertexID vertexId, int taskIndex, int parallelism, ExecutionAttemptID executionId, String taskName, TaskManager taskManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelExecution()
void	cancelingDone()
void	failExternally(Throwable cause) Sets the tasks to be cancelled and reports a failure back to the master.
RuntimeEnvironment	getEnvironment()
ExecutionAttemptID	getExecutionId() Gets the ID of the execution attempt.
ExecutionState	getExecutionState() Returns the current execution state of the task.
JobID	getJobID() Returns the ID of the job this task belongs to.
int	getNumberOfSubtasks() Gets the total number of subtasks of the task that this subtask belongs to.
int	getSubtaskIndex() Gets the index of the parallel subtask [0, parallelism).
String	getTaskName()
String	getTaskNameWithSubtasks()
JobVertexID	getVertexID() Returns the ID of this task vertex.
boolean	isCanceledOrFailed()
boolean	markAsFinished() Marks the task as finished.
void	markFailed(Throwable error)
void	registerExecutionListener(ExecutionListener listener)
void	registerProfiler(TaskManagerProfiler taskManagerProfiler, Configuration jobConfiguration) Registers the task manager profiler with the task.
void	setEnvironment(RuntimeEnvironment environment)
boolean	startExecution() Starts the execution of this task.
String	toString()
void	unregisterExecutionListener(ExecutionListener listener)
void	unregisterMemoryManager(MemoryManager memoryManager) Unregisters the task from the central memory manager.
void	unregisterProfiler(TaskManagerProfiler taskManagerProfiler) Unregisters the task from the task manager profiler.

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task(JobID jobId,
    JobVertexID vertexId,
    int taskIndex,
    int parallelism,
    ExecutionAttemptID executionId,
    String taskName,
    TaskManager taskManager)

Method Detail

getJobID

public JobID getJobID()

Returns the ID of the job this task belongs to.

Returns:

the ID of the job this task belongs to

getVertexID

public JobVertexID getVertexID()

Returns the ID of this task vertex.

Returns:

the ID of this task vertex.

getSubtaskIndex

public int getSubtaskIndex()

Gets the index of the parallel subtask [0, parallelism).

Returns:

The task index of the parallel subtask.

getNumberOfSubtasks

public int getNumberOfSubtasks()

Gets the total number of subtasks of the task that this subtask belongs to.

Returns:

The total number of this task's subtasks.

getExecutionId

public ExecutionAttemptID getExecutionId()

Gets the ID of the execution attempt.

Returns:

The ID of the execution attempt.

getExecutionState

public ExecutionState getExecutionState()

Returns the current execution state of the task.

Returns:

the current execution state of the task

setEnvironment

public void setEnvironment(RuntimeEnvironment environment)

getEnvironment

public RuntimeEnvironment getEnvironment()

isCanceledOrFailed

public boolean isCanceledOrFailed()

getTaskName

public String getTaskName()

getTaskNameWithSubtasks

public String getTaskNameWithSubtasks()

markAsFinished

public boolean markAsFinished()

Marks the task as finished. This succeeds, if the task was previously in the state "RUNNING", otherwise it fails. Failure indicates that the task was either canceled, or set to failed.

Returns:

True, if the task correctly enters the state FINISHED.

markFailed

public void markFailed(Throwable error)

cancelExecution

public void cancelExecution()

failExternally

public void failExternally(Throwable cause)

Sets the tasks to be cancelled and reports a failure back to the master. This method is important if a failure needs to be reported to the master, because a simple canceled m

Parameters:

cause - The exception to report in the error message

cancelingDone

public void cancelingDone()

startExecution

public boolean startExecution()

Starts the execution of this task.

unregisterMemoryManager

public void unregisterMemoryManager(MemoryManager memoryManager)

Unregisters the task from the central memory manager.

Parameters:

memoryManager - the central memory manager

registerProfiler

public void registerProfiler(TaskManagerProfiler taskManagerProfiler,
                    Configuration jobConfiguration)

Registers the task manager profiler with the task.

Parameters:

taskManagerProfiler - the task manager profiler

jobConfiguration - the configuration attached to the job

unregisterProfiler

public void unregisterProfiler(TaskManagerProfiler taskManagerProfiler)

Unregisters the task from the task manager profiler.

Parameters:

taskManagerProfiler - the task manager profiler

registerExecutionListener

public void registerExecutionListener(ExecutionListener listener)

unregisterExecutionListener

public void unregisterExecutionListener(ExecutionListener listener)

toString

public String toString()

Overrides:

toString in class Object