Packages

abstract class StreamingQueryListener extends Serializable

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
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamingQueryListener
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StreamingQueryListener()

Abstract Value Members

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

    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

    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

    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
    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( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. def onQueryIdle(event: QueryIdleEvent): Unit

    Called when the query is idle and waiting for new data to process.

    Called when the query is idle and waiting for new data to process.

    Since

    3.5.0

  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped