Class

org.apache.spark.sql.execution.streaming

StreamingQueryListenerBus

Related Doc: package streaming

Permalink

class StreamingQueryListenerBus extends SparkListener with ListenerBus[StreamingQueryListener, Event]

A bus to forward events to StreamingQueryListeners. This one will send received StreamingQueryListener.Events to the Spark listener bus. It also registers itself with Spark listener bus, so that it can receive StreamingQueryListener.Events and dispatch them to StreamingQueryListeners.

Note that each bus and its registered listeners are associated with a single SparkSession and StreamingQueryManager. So this bus will dispatch events to registered listeners for only those queries that were started in the associated SparkSession.

Linear Supertypes
ListenerBus[StreamingQueryListener, Event], internal.Logging, SparkListener, SparkListenerInterface, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamingQueryListenerBus
  2. ListenerBus
  3. Logging
  4. SparkListener
  5. SparkListenerInterface
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StreamingQueryListenerBus(sparkListenerBus: LiveListenerBus)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def addListener(listener: StreamingQueryListener): Unit

    Permalink

    Add a listener to listen events.

    Add a listener to listen events. This method is thread-safe and can be called in any thread.

    Definition Classes
    ListenerBus
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def doPostEvent(listener: StreamingQueryListener, event: Event): Unit

    Permalink

    Dispatch events to registered StreamingQueryListeners.

    Dispatch events to registered StreamingQueryListeners. Only the events associated queries started in the same SparkSession as this ListenerBus will be dispatched to the listeners.

    Attributes
    protected
    Definition Classes
    StreamingQueryListenerBus → ListenerBus
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean = false): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  14. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  17. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  18. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  19. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  20. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  21. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  22. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  23. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  24. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  25. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  26. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  27. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  28. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  29. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. def onApplicationEnd(applicationEnd: SparkListenerApplicationEnd): Unit

    Permalink

    Called when the application ends

    Called when the application ends

    Definition Classes
    SparkListener → SparkListenerInterface
  33. def onApplicationStart(applicationStart: SparkListenerApplicationStart): Unit

    Permalink

    Called when the application starts

    Called when the application starts

    Definition Classes
    SparkListener → SparkListenerInterface
  34. def onBlockManagerAdded(blockManagerAdded: SparkListenerBlockManagerAdded): Unit

    Permalink

    Called when a new block manager has joined

    Called when a new block manager has joined

    Definition Classes
    SparkListener → SparkListenerInterface
  35. def onBlockManagerRemoved(blockManagerRemoved: SparkListenerBlockManagerRemoved): Unit

    Permalink

    Called when an existing block manager has been removed

    Called when an existing block manager has been removed

    Definition Classes
    SparkListener → SparkListenerInterface
  36. def onBlockUpdated(blockUpdated: SparkListenerBlockUpdated): Unit

    Permalink

    Called when the driver receives a block update info.

    Called when the driver receives a block update info.

    Definition Classes
    SparkListener → SparkListenerInterface
  37. def onEnvironmentUpdate(environmentUpdate: SparkListenerEnvironmentUpdate): Unit

    Permalink

    Called when environment properties have been updated

    Called when environment properties have been updated

    Definition Classes
    SparkListener → SparkListenerInterface
  38. def onExecutorAdded(executorAdded: SparkListenerExecutorAdded): Unit

    Permalink

    Called when the driver registers a new executor.

    Called when the driver registers a new executor.

    Definition Classes
    SparkListener → SparkListenerInterface
  39. def onExecutorMetricsUpdate(executorMetricsUpdate: SparkListenerExecutorMetricsUpdate): Unit

    Permalink

    Called when the driver receives task metrics from an executor in a heartbeat.

    Called when the driver receives task metrics from an executor in a heartbeat.

    Definition Classes
    SparkListener → SparkListenerInterface
  40. def onExecutorRemoved(executorRemoved: SparkListenerExecutorRemoved): Unit

    Permalink

    Called when the driver removes an executor.

    Called when the driver removes an executor.

    Definition Classes
    SparkListener → SparkListenerInterface
  41. def onJobEnd(jobEnd: SparkListenerJobEnd): Unit

    Permalink

    Called when a job ends

    Called when a job ends

    Definition Classes
    SparkListener → SparkListenerInterface
  42. def onJobStart(jobStart: SparkListenerJobStart): Unit

    Permalink

    Called when a job starts

    Called when a job starts

    Definition Classes
    SparkListener → SparkListenerInterface
  43. def onOtherEvent(event: SparkListenerEvent): Unit

    Permalink

    Called when other events like SQL-specific events are posted.

    Called when other events like SQL-specific events are posted.

    Definition Classes
    StreamingQueryListenerBusSparkListener → SparkListenerInterface
  44. def onStageCompleted(stageCompleted: SparkListenerStageCompleted): Unit

    Permalink

    Called when a stage completes successfully or fails, with information on the completed stage.

    Called when a stage completes successfully or fails, with information on the completed stage.

    Definition Classes
    SparkListener → SparkListenerInterface
  45. def onStageSubmitted(stageSubmitted: SparkListenerStageSubmitted): Unit

    Permalink

    Called when a stage is submitted

    Called when a stage is submitted

    Definition Classes
    SparkListener → SparkListenerInterface
  46. def onTaskEnd(taskEnd: SparkListenerTaskEnd): Unit

    Permalink

    Called when a task ends

    Called when a task ends

    Definition Classes
    SparkListener → SparkListenerInterface
  47. def onTaskGettingResult(taskGettingResult: SparkListenerTaskGettingResult): Unit

    Permalink

    Called when a task begins remotely fetching its result (will not be called for tasks that do not need to fetch the result remotely).

    Called when a task begins remotely fetching its result (will not be called for tasks that do not need to fetch the result remotely).

    Definition Classes
    SparkListener → SparkListenerInterface
  48. def onTaskStart(taskStart: SparkListenerTaskStart): Unit

    Permalink

    Called when a task starts

    Called when a task starts

    Definition Classes
    SparkListener → SparkListenerInterface
  49. def onUnpersistRDD(unpersistRDD: SparkListenerUnpersistRDD): Unit

    Permalink

    Called when an RDD is manually unpersisted by the application

    Called when an RDD is manually unpersisted by the application

    Definition Classes
    SparkListener → SparkListenerInterface
  50. def post(event: Event): Unit

    Permalink

    Post a StreamingQueryListener event to the added StreamingQueryListeners.

    Post a StreamingQueryListener event to the added StreamingQueryListeners. Note that only the QueryStarted event is posted to the listener synchronously. Other events are dispatched to Spark listener bus. This method is guaranteed to be called by queries in the same SparkSession as this listener.

  51. def postToAll(event: Event): Unit

    Permalink

    Override the parent postToAll to remove the query id from activeQueryRunIds after all the listeners process QueryTerminatedEvent.

    Override the parent postToAll to remove the query id from activeQueryRunIds after all the listeners process QueryTerminatedEvent. (SPARK-19594)

    Definition Classes
    StreamingQueryListenerBus → ListenerBus
  52. final def removeListener(listener: StreamingQueryListener): Unit

    Permalink

    Remove a listener and it won't receive any events.

    Remove a listener and it won't receive any events. This method is thread-safe and can be called in any thread.

    Definition Classes
    ListenerBus
  53. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  54. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ListenerBus[StreamingQueryListener, Event]

Inherited from internal.Logging

Inherited from SparkListener

Inherited from SparkListenerInterface

Inherited from AnyRef

Inherited from Any

Ungrouped