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.
- Alphabetic
- By Inheritance
- StreamingQueryListener
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new StreamingQueryListener()
Abstract Value Members
- 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
.
- 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 beforeDataStreamWriter.start()
returns the corresponding StreamingQuery. Please don't block this method as it will block your query.
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)