org.apache.spark.sql.streaming

Class StreamingQueryListener

Object

org.apache.spark.sql.streaming.StreamingQueryListener

public abstract class StreamingQueryListener
extends Object

:: Experimental :: Interface for listening to events related to StreamingQueries.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StreamingQueryListener.Event :: Experimental :: Base type of StreamingQueryListener events
static class	StreamingQueryListener.QueryProgressEvent :: Experimental :: Event representing any progress updates in a query
static class	StreamingQueryListener.QueryStartedEvent :: Experimental :: Event representing the start of a query
static class	StreamingQueryListener.QueryTerminatedEvent :: Experimental :: Event representing that termination of a query

Constructor Summary

Constructors

Constructor and Description
StreamingQueryListener()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	onQueryProgress(StreamingQueryListener.QueryProgressEvent event) Called when there is some status update (ingestion rate updated, etc.)
abstract void	onQueryStarted(StreamingQueryListener.QueryStartedEvent event) Called when a query is started.
abstract void	onQueryTerminated(StreamingQueryListener.QueryTerminatedEvent event) Called when a query is stopped, with or without error.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamingQueryListener

public StreamingQueryListener()

Method Detail

onQueryStarted

public abstract void onQueryStarted(StreamingQueryListener.QueryStartedEvent event)

Called when a query is started.

Parameters:

event - (undocumented)

Since:

2.0.0

onQueryProgress

public abstract void onQueryProgress(StreamingQueryListener.QueryProgressEvent event)

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

Parameters:

event - (undocumented)

Since:

2.0.0

onQueryTerminated

public abstract void onQueryTerminated(StreamingQueryListener.QueryTerminatedEvent event)

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

Parameters:

event - (undocumented)

Since:

2.0.0