Packages

t

org.apache.spark.api.plugin

ExecutorPlugin

trait ExecutorPlugin extends AnyRef

:: DeveloperApi :: Executor component of a SparkPlugin.

Annotations
@DeveloperApi()
Source
ExecutorPlugin.java
Since

3.0.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExecutorPlugin
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def init(ctx: PluginContext, extraConf: Map[String, String]): Unit

    Initialize the executor plugin.

    Initialize the executor plugin.

    When a Spark plugin provides an executor plugin, this method will be called during the initialization of the executor process. It will block executor initialization until it returns.

    Executor plugins that publish metrics should register all metrics with the context's registry (PluginContext#metricRegistry()) when this method is called. Metrics registered afterwards are not guaranteed to show up.

    ctx

    Context information for the executor where the plugin is running.

    extraConf

    Extra configuration provided by the driver component during its initialization.

  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. def onTaskFailed(failureReason: TaskFailedReason): Unit

    Perform an action after tasks completes with exceptions.

    Perform an action after tasks completes with exceptions.

    Same warnings of onTaskStart apply here.

    failureReason

    the exception thrown from the failed task.

    Since

    3.1.0

  16. def onTaskStart(): Unit

    Perform any action before the task is run.

    Perform any action before the task is run.

    This method is invoked from the same thread the task will be executed. Task-specific information can be accessed via org.apache.spark.TaskContext#get.

    Plugin authors should avoid expensive operations here, as this method will be called on every task, and doing something expensive can significantly slow down a job. It is not recommended for a user to call a remote service, for example.

    Exceptions thrown from this method do not propagate - they're caught, logged, and suppressed. Therefore exceptions when executing this method won't make the job fail.

    Since

    3.1.0

  17. def onTaskSucceeded(): Unit

    Perform an action after tasks completes without exceptions.

    Perform an action after tasks completes without exceptions.

    As onTaskStart exceptions are suppressed, this method will still be invoked even if the corresponding #onTaskStart call for this task failed.

    Same warnings of onTaskStart apply here.

    Since

    3.1.0

  18. def shutdown(): Unit

    Clean up and terminate this plugin.

    Clean up and terminate this plugin.

    This method is called during the executor shutdown phase, and blocks executor shutdown.

  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped