org.apache.spark

Class TaskContextImpl

Object

org.apache.spark.TaskContext

org.apache.spark.TaskContextImpl

All Implemented Interfaces:

java.io.Serializable, Logging

public class TaskContextImpl
extends TaskContext
implements Logging

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskContextImpl(int stageId, int partitionId, long taskAttemptId, int attemptNumber, 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) Adds a callback function to be executed on task completion.
TaskContextImpl	addTaskCompletionListener(scala.Function1<TaskContext,scala.runtime.BoxedUnit> f) Adds a listener in the form of a Scala closure to be executed on task completion.
TaskContextImpl	addTaskCompletionListener(TaskCompletionListener listener) Adds a (Java friendly) listener to be executed on task completion.
long	attemptId()
int	attemptNumber() How many times this task has been attempted.
boolean	isCompleted() Returns true if the task has completed.
boolean	isInterrupted() Returns true if the task has been killed.
boolean	isRunningLocally() Returns true if the task is running locally in the driver program.
void	markInterrupted() Marks the task for interruption, i.e.
void	markTaskCompleted() Marks the task as completed and triggers the listeners.
int	partitionId() The ID of the RDD partition that is computed by this task.
boolean	runningLocally()
int	stageId() The ID of the stage that this task belong to.
long	taskAttemptId() An ID that is unique to this task attempt (within the same SparkContext, no two task attempts will share the same attempt ID).
org.apache.spark.executor.TaskMetrics	taskMetrics() ::DeveloperApi::

Methods inherited from class org.apache.spark.TaskContext

get

Methods inherited from class Object

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

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

TaskContextImpl

public TaskContextImpl(int stageId,
               int partitionId,
               long taskAttemptId,
               int attemptNumber,
               boolean runningLocally,
               org.apache.spark.executor.TaskMetrics taskMetrics)

Method Detail

stageId

public int stageId()

Description copied from class: TaskContext

The ID of the stage that this task belong to.

Specified by:

stageId in class TaskContext

partitionId

public int partitionId()

Description copied from class: TaskContext

The ID of the RDD partition that is computed by this task.

Specified by:

partitionId in class TaskContext

taskAttemptId

public long taskAttemptId()

Description copied from class: TaskContext

An ID that is unique to this task attempt (within the same SparkContext, no two task attempts will share the same attempt ID). This is roughly equivalent to Hadoop's TaskAttemptID.

Specified by:

taskAttemptId in class TaskContext

attemptNumber

public int attemptNumber()

Description copied from class: TaskContext

How many times this task has been attempted. The first task attempt will be assigned attemptNumber = 0, and subsequent attempts will have increasing attempt numbers.

Specified by:

attemptNumber in class TaskContext

runningLocally

public boolean runningLocally()

Specified by:

runningLocally in class TaskContext

taskMetrics

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

Description copied from class: TaskContext

::DeveloperApi::

Specified by:

taskMetrics in class TaskContext

attemptId

public long attemptId()

Specified by:

attemptId in class TaskContext

addTaskCompletionListener

public TaskContextImpl addTaskCompletionListener(TaskCompletionListener listener)

Description copied from class: TaskContext

Adds 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.

Specified by:

addTaskCompletionListener in class TaskContext

addTaskCompletionListener

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

Description copied from class: TaskContext

Adds a listener in the form of a Scala closure to be executed on task completion. This will be called in all situations - success, failure, or cancellation. An example use is for HadoopRDD to register a callback to close the input stream.

Specified by:

addTaskCompletionListener in class TaskContext

addOnCompleteCallback

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

Description copied from class: TaskContext

Adds 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.

Specified by:

addOnCompleteCallback in class TaskContext

Parameters:

f - Callback function.

markTaskCompleted

public void markTaskCompleted()

Marks the task as completed and triggers the listeners.

markInterrupted

public void markInterrupted()

Marks the task for interruption, i.e. cancellation.

isCompleted

public boolean isCompleted()

Description copied from class: TaskContext

Returns true if the task has completed.

Specified by:

isCompleted in class TaskContext

isRunningLocally

public boolean isRunningLocally()

Description copied from class: TaskContext

Returns true if the task is running locally in the driver program.

Specified by:

isRunningLocally in class TaskContext

Returns:

isInterrupted

public boolean isInterrupted()

Description copied from class: TaskContext

Returns true if the task has been killed.

Specified by:

isInterrupted in class TaskContext