Spark 3.5.3 ScalaDoc - org.apache.spark.BarrierTaskContext

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(listener: TaskCompletionListener): BarrierTaskContext.this.type

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.

Two listeners registered in the same thread will be invoked in reverse order of registration if the task completes after both are registered. There are no ordering guarantees for listeners registered in different threads, or for listeners registered after the task completes. Listeners are guaranteed to execute sequentially.

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.

Definition Classes: BarrierTaskContext → TaskContext

def addTaskCompletionListener[U](f: (TaskContext) ⇒ U): 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.

Definition Classes: TaskContext

def addTaskFailureListener(listener: TaskFailureListener): BarrierTaskContext.this.type

Adds a listener to be executed on task failure (which includes completion listener failure, if the task body did not already fail).

Adds a listener to be executed on task failure (which includes completion listener failure, if the task body did not already fail). Adding a listener to an already failed task will result in that listener being called immediately.

Note: Prior to Spark 3.4.0, failure listeners were only invoked if the main task body failed.

Definition Classes: BarrierTaskContext → TaskContext

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

Adds a listener to be executed on task failure (which includes completion listener failure, if the task body did not already fail).

Adds a listener to be executed on task failure (which includes completion listener failure, if the task body did not already fail). Adding a listener to an already failed task will result in that listener being called immediately.

Note: Prior to Spark 3.4.0, failure listeners were only invoked if the main task body failed.

Definition Classes: TaskContext

def allGather(message: String): Array[String]

:: Experimental :: Blocks until all tasks in the same stage have reached this routine.

:: Experimental :: Blocks until all tasks in the same stage have reached this routine. Each task passes in a message and returns with a list of all the messages passed in by each of those tasks.

CAUTION! The allGather method requires the same precautions as the barrier method

The message is type String rather than Array[Byte] because it is more convenient for the user at the cost of worse performance.

Annotations: @Experimental() @Since( "3.0.0" )

final def asInstanceOf[T0]: T0

Definition Classes: Any

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.

Definition Classes: BarrierTaskContext → TaskContext

def barrier(): Unit

:: Experimental :: Sets a global barrier and waits until all tasks in this stage hit this barrier.

:: Experimental :: Sets a global barrier and waits until all tasks in this stage hit this barrier. Similar to MPI_Barrier function in MPI, the barrier() function call blocks until all tasks in the same stage have reached this routine.

CAUTION! In a barrier stage, each task must have the same number of barrier() calls, in all possible code branches. Otherwise, you may get the job hanging or a SparkException after timeout. Some examples of misuses are listed below: 1. Only call barrier() function on a subset of all the tasks in the same barrier stage, it shall lead to timeout of the function call.

rdd.barrier().mapPartitions { iter =>
    val context = BarrierTaskContext.get()
    if (context.partitionId() == 0) {
        // Do nothing.
    } else {
        context.barrier()
    }
    iter
}

2. Include barrier() function in a try-catch code block, this may lead to timeout of the second function call.

rdd.barrier().mapPartitions { iter =>
    val context = BarrierTaskContext.get()
    try {
        // Do something that might throw an Exception.
        doSomething()
        context.barrier()
    } catch {
        case e: Exception => logWarning("...", e)
    }
    context.barrier()
    iter
}

Annotations: @Experimental() @Since( "2.4.0" )

def clone(): AnyRef

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( ... ) @native()

def cpus(): Int

CPUs allocated to the task.

Definition Classes: BarrierTaskContext → TaskContext

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def finalize(): Unit

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

final def getClass(): Class[_]

Definition Classes: AnyRef → Any
Annotations: @native()

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.

Definition Classes: BarrierTaskContext → TaskContext

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.

Definition Classes: BarrierTaskContext → TaskContext

def getTaskInfos(): Array[BarrierTaskInfo]

:: Experimental :: Returns BarrierTaskInfo for all tasks in this barrier stage, ordered by partition ID.

Annotations: @Experimental() @Since( "2.4.0" )

def hashCode(): Int

Definition Classes: AnyRef → Any
Annotations: @native()

def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

Attributes: protected
Definition Classes: Logging

def initializeLogIfNecessary(isInterpreter: Boolean): Unit

Attributes: protected
Definition Classes: Logging

def isCompleted(): Boolean

Returns true if the task has completed.

Definition Classes: BarrierTaskContext → TaskContext

def isFailed(): Boolean

Returns true if the task has failed.

Definition Classes: BarrierTaskContext → TaskContext

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

def isInterrupted(): Boolean

Returns true if the task has been killed.

Definition Classes: BarrierTaskContext → TaskContext

def isTraceEnabled(): Boolean

Attributes: protected
Definition Classes: Logging

def log: Logger

Attributes: protected
Definition Classes: Logging

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logDebug(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logError(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logInfo(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

def logName: String

Attributes: protected
Definition Classes: Logging

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logTrace(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logWarning(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def notify(): Unit

Definition Classes: AnyRef
Annotations: @native()

final def notifyAll(): Unit

Definition Classes: AnyRef
Annotations: @native()

def numPartitions(): Int

Total number of partitions in the stage that this task belongs to.

Definition Classes: BarrierTaskContext → TaskContext

def partitionId(): Int

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

Definition Classes: BarrierTaskContext → TaskContext

def resources(): Map[String, ResourceInformation]

Resources allocated to the task.

Resources allocated to the task. The key is the resource name and the value is information about the resource. Please refer to org.apache.spark.resource.ResourceInformation for specifics.

Definition Classes: BarrierTaskContext → TaskContext

def resourcesJMap(): Map[String, ResourceInformation]

(java-specific) Resources allocated to the task.

(java-specific) Resources allocated to the task. The key is the resource name and the value is information about the resource. Please refer to org.apache.spark.resource.ResourceInformation for specifics.

Definition Classes: BarrierTaskContext → TaskContext

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.

Definition Classes: BarrierTaskContext → TaskContext

def stageId(): Int

The ID of the stage that this task belong to.

Definition Classes: BarrierTaskContext → TaskContext

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

Definition Classes: AnyRef

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.

Definition Classes: BarrierTaskContext → TaskContext

def taskMetrics(): TaskMetrics

Definition Classes: BarrierTaskContext → TaskContext

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( ... ) @native()

Packages

BarrierTaskContext

Companion object BarrierTaskContext

class BarrierTaskContext extends TaskContext with Logging

Value Members

Inherited from Logging

Inherited from TaskContext

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped