Packages

t

org.apache.spark.launcher

SparkAppHandle

trait SparkAppHandle extends AnyRef

A handle to a running Spark application.

Provides runtime information about the underlying Spark application, and actions to control it.

Source
SparkAppHandle.java
Since

1.6.0

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

Abstract Value Members

  1. abstract def addListener(l: Listener): Unit

    Adds a listener to be notified of changes to the handle's information.

    Adds a listener to be notified of changes to the handle's information. Listeners will be called from the thread processing updates from the application, so they should avoid blocking or long-running operations.

    l

    Listener to add.

  2. abstract def disconnect(): Unit

    Disconnects the handle from the application, without stopping it.

    Disconnects the handle from the application, without stopping it. After this method is called, the handle will not be able to communicate with the application anymore.

  3. abstract def getAppId(): String

    Returns the application ID, or null if not yet known.

  4. abstract def getError(): Optional[Throwable]

    If the application failed due to an error, return the underlying error.

    If the application failed due to an error, return the underlying error. If the app succeeded, this method returns an empty Optional.

  5. abstract def getState(): State

    Returns the current application state.

  6. abstract def kill(): Unit

    Tries to kill the underlying application.

    Tries to kill the underlying application. Implies #disconnect(). This will not send a #stop() message to the application, so it's recommended that users first try to stop the application cleanly and only resort to this method if that fails.

  7. abstract def stop(): Unit

    Asks the application to stop.

    Asks the application to stop. This is best-effort, since the application may fail to receive or act on the command. Callers should watch for a state transition that indicates the application has really stopped.