StreamingListener (Spark 3.5.1 JavaDoc)

All Known Implementing Classes:: StatsReportListener

public interface StreamingListener

:: DeveloperApi :: A listener interface for receiving information about an ongoing streaming computation.

Method Summary

Modifier and Type

Method

Description

void

onBatchCompleted(StreamingListenerBatchCompleted batchCompleted)

Called when processing of a batch of jobs has completed.

void

onBatchStarted(StreamingListenerBatchStarted batchStarted)

Called when processing of a batch of jobs has started.

void

onBatchSubmitted(StreamingListenerBatchSubmitted batchSubmitted)

Called when a batch of jobs has been submitted for processing.

void

onOutputOperationCompleted(StreamingListenerOutputOperationCompleted outputOperationCompleted)

Called when processing of a job of a batch has completed.

void

onOutputOperationStarted(StreamingListenerOutputOperationStarted outputOperationStarted)

Called when processing of a job of a batch has started.

void

onReceiverError(StreamingListenerReceiverError receiverError)

Called when a receiver has reported an error

void

onReceiverStarted(StreamingListenerReceiverStarted receiverStarted)

Called when a receiver has been started

void

onReceiverStopped(StreamingListenerReceiverStopped receiverStopped)

Called when a receiver has been stopped

void

onStreamingStarted(StreamingListenerStreamingStarted streamingStarted)

Called when the streaming has been started

Method Details
- onBatchCompleted
  
  void onBatchCompleted(StreamingListenerBatchCompleted batchCompleted)
  
  Called when processing of a batch of jobs has completed.
- onBatchStarted
  
  void onBatchStarted(StreamingListenerBatchStarted batchStarted)
  
  Called when processing of a batch of jobs has started.
- onBatchSubmitted
  
  void onBatchSubmitted(StreamingListenerBatchSubmitted batchSubmitted)
  
  Called when a batch of jobs has been submitted for processing.
- onOutputOperationCompleted
  
  void onOutputOperationCompleted(StreamingListenerOutputOperationCompleted outputOperationCompleted)
  
  Called when processing of a job of a batch has completed.
- onOutputOperationStarted
  
  void onOutputOperationStarted(StreamingListenerOutputOperationStarted outputOperationStarted)
  
  Called when processing of a job of a batch has started.
- onReceiverError
  
  void onReceiverError(StreamingListenerReceiverError receiverError)
  
  Called when a receiver has reported an error
- onReceiverStarted
  
  void onReceiverStarted(StreamingListenerReceiverStarted receiverStarted)
  
  Called when a receiver has been started
- onReceiverStopped
  
  void onReceiverStopped(StreamingListenerReceiverStopped receiverStopped)
  
  Called when a receiver has been stopped
- onStreamingStarted
  
  void onStreamingStarted(StreamingListenerStreamingStarted streamingStarted)
  
  Called when the streaming has been started