TaskContext

Instance Constructors

new TaskContext()

Abstract Value Members

abstract def addTaskCompletionListener(listener: TaskCompletionListener): TaskContext

Adds a (Java friendly) listener to be executed on task completion.
Adds a (Java friendly) listener to be executed on task completion. This will be called in all situations - success, failure, or cancellation. Adding a listener to an already completed task will result in that listener being called immediately.
An example use is for HadoopRDD to register a callback to close the input stream.
Exceptions thrown by the listener will result in failure of the task.
abstract def addTaskFailureListener(listener: TaskFailureListener): TaskContext

Adds a listener to be executed on task failure.
Adds a listener to be executed on task failure. Adding a listener to an already failed task will result in that listener being called immediately.
abstract def attemptNumber(): Int

How many times this task has been attempted.
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.
abstract def getLocalProperty(key: String): String

Get a local property set upstream in the driver, or null if it is missing.
Get a local property set upstream in the driver, or null if it is missing. See also org.apache.spark.SparkContext.setLocalProperty.
abstract def getMetricsSources(sourceName: String): Seq[Source]

::DeveloperApi:: Returns all metrics sources with the given name which are associated with the instance which runs the task.
::DeveloperApi:: Returns all metrics sources with the given name which are associated with the instance which runs the task. For more information see org.apache.spark.metrics.MetricsSystem.

Annotations
@DeveloperApi()
abstract def isCompleted(): Boolean

Returns true if the task has completed.
abstract def isInterrupted(): Boolean

Returns true if the task has been killed.
abstract def partitionId(): Int

The ID of the RDD partition that is computed by this task.
abstract def stageAttemptNumber(): Int

How many times the stage that this task belongs to has been attempted.
How many times the stage that this task belongs to has been attempted. The first stage attempt will be assigned stageAttemptNumber = 0, and subsequent attempts will have increasing attempt numbers.
abstract def stageId(): Int

The ID of the stage that this task belong to.
abstract def taskAttemptId(): Long

An ID that is unique to this task attempt (within the same SparkContext, no two task attempts will share the same attempt ID).
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.
abstract def taskMetrics(): TaskMetrics

Annotations
@DeveloperApi()
abstract def isRunningLocally(): Boolean

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

Annotations
@deprecated
Deprecated
(Since version 2.0.0) Local execution was removed, so this always returns false

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addTaskCompletionListener(f: (TaskContext) ⇒ Unit): TaskContext

Adds a listener in the form of a Scala closure to be executed on task completion.
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. Adding a listener to an already completed task will result in that listener being called immediately.
An example use is for HadoopRDD to register a callback to close the input stream.
Exceptions thrown by the listener will result in failure of the task.
def addTaskFailureListener(f: (TaskContext, Throwable) ⇒ Unit): TaskContext

Adds a listener to be executed on task failure.
Adds a listener to be executed on task failure. Adding a listener to an already failed task will result in that listener being called immediately.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object TaskContext | package spark

abstract class TaskContext extends Serializable

Instance Constructors

new TaskContext()

Abstract Value Members

abstract def addTaskCompletionListener(listener: TaskCompletionListener): TaskContext

abstract def addTaskFailureListener(listener: TaskFailureListener): TaskContext

abstract def attemptNumber(): Int

abstract def getLocalProperty(key: String): String

abstract def getMetricsSources(sourceName: String): Seq[Source]

abstract def isCompleted(): Boolean

abstract def isInterrupted(): Boolean

abstract def partitionId(): Int

abstract def stageAttemptNumber(): Int

abstract def stageId(): Int

abstract def taskAttemptId(): Long

abstract def taskMetrics(): TaskMetrics

abstract def isRunningLocally(): Boolean

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addTaskCompletionListener(f: (TaskContext) ⇒ Unit): TaskContext

def addTaskFailureListener(f: (TaskContext, Throwable) ⇒ Unit): TaskContext

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped