org.apache.spark

Class TaskContext

Object

org.apache.spark.TaskContext

All Implemented Interfaces:

java.io.Serializable

public class TaskContext
extends Object
implements scala.Serializable

:: DeveloperApi :: Contextual information about a task which can be read or mutated during execution.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskContext(int stageId, int partitionId, long attemptId, boolean runningLocally, org.apache.spark.executor.TaskMetrics taskMetrics)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOnCompleteCallback(scala.Function0<scala.runtime.BoxedUnit> f) Add a callback function to be executed on task completion.
TaskContext	addTaskCompletionListener(scala.Function1<TaskContext,scala.runtime.BoxedUnit> f) Add a listener in the form of a Scala closure to be executed on task completion.
TaskContext	addTaskCompletionListener(TaskCompletionListener listener) Add a (Java friendly) listener to be executed on task completion.
long	attemptId()
boolean	isCompleted() Checks whether the task has completed.
boolean	isInterrupted() Checks whether the task has been killed.
int	partitionId()
boolean	runningLocally()
int	splitId()
int	stageId()
org.apache.spark.executor.TaskMetrics	taskMetrics()

Methods inherited from class Object

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

Constructor Detail

TaskContext

public TaskContext(int stageId,
           int partitionId,
           long attemptId,
           boolean runningLocally,
           org.apache.spark.executor.TaskMetrics taskMetrics)

Method Detail

stageId

public int stageId()

partitionId

public int partitionId()

attemptId

public long attemptId()

runningLocally

public boolean runningLocally()

taskMetrics

public org.apache.spark.executor.TaskMetrics taskMetrics()

splitId

public int splitId()

isCompleted

public boolean isCompleted()

Checks whether the task has completed.

isInterrupted

public boolean isInterrupted()

Checks whether the task has been killed.

addTaskCompletionListener

public TaskContext addTaskCompletionListener(TaskCompletionListener listener)

Add a (Java friendly) listener to be executed on task completion. This will be called in all situation - success, failure, or cancellation.

An example use is for HadoopRDD to register a callback to close the input stream.

addTaskCompletionListener

public TaskContext addTaskCompletionListener(scala.Function1<TaskContext,scala.runtime.BoxedUnit> f)

Add a listener in the form of a Scala closure to be executed on task completion. This will be called in all situation - success, failure, or cancellation.

An example use is for HadoopRDD to register a callback to close the input stream.

addOnCompleteCallback

public void addOnCompleteCallback(scala.Function0<scala.runtime.BoxedUnit> f)

Add a callback function to be executed on task completion. An example use is for HadoopRDD to register a callback to close the input stream. Will be called in any situation - success, failure, or cancellation.

Parameters:

f - Callback function.