Class/Object

org.apache.spark.sql.streaming

StreamingQueryListener

Related Docs: object StreamingQueryListener | package streaming

Permalink

abstract class StreamingQueryListener extends AnyRef

Interface for listening to events related to StreamingQueries.

Annotations
@Evolving()
Source
StreamingQueryListener.scala
Since

2.0.0

Note

The methods are not thread-safe as they may be called from different threads.

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

Instance Constructors

  1. new StreamingQueryListener()

    Permalink

Abstract Value Members

  1. abstract def onQueryProgress(event: QueryProgressEvent): Unit

    Permalink

    Called when there is some status update (ingestion rate updated, etc.)

    Called when there is some status update (ingestion rate updated, etc.)

    Since

    2.0.0

    Note

    This method is asynchronous. The status in StreamingQuery will always be latest no matter when this method is called. Therefore, the status of StreamingQuery may be changed before/when you process the event. E.g., you may find StreamingQuery is terminated when you are processing QueryProgressEvent.

  2. abstract def onQueryStarted(event: QueryStartedEvent): Unit

    Permalink

    Called when a query is started.

    Called when a query is started.

    Since

    2.0.0

    Note

    This is called synchronously with DataStreamWriter.start(), that is, onQueryStart will be called on all listeners before DataStreamWriter.start() returns the corresponding StreamingQuery. Please don't block this method as it will block your query.

  3. abstract def onQueryTerminated(event: QueryTerminatedEvent): Unit

    Permalink

    Called when a query is stopped, with or without error.

    Called when a query is stopped, with or without error.

    Since

    2.0.0

Concrete 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 asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped