SparkFirehoseListener (Spark 3.0.0-preview2 JavaDoc)

Object
- org.apache.spark.SparkFirehoseListener

All Implemented Interfaces:

SparkListenerInterface
```
public class SparkFirehoseListener
extends Object
implements SparkListenerInterface
```
Class that allows users to receive all SparkListener events. Users should override the onEvent method. This is a concrete Java class in order to ensure that we don't forget to update it when adding new methods to SparkListener: forgetting to add a method will result in a compilation error (if this was a concrete Scala class, default implementations of new event handlers would be inherited from the SparkListener trait).

Constructor Summary

Constructors
Constructor and Description

SparkFirehoseListener()

Constructors
Constructor and Description
`SparkFirehoseListener()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`onApplicationEnd(SparkListenerApplicationEnd applicationEnd)` Called when the application ends
`void`	`onApplicationStart(SparkListenerApplicationStart applicationStart)` Called when the application starts
`void`	`onBlockManagerAdded(SparkListenerBlockManagerAdded blockManagerAdded)` Called when a new block manager has joined
`void`	`onBlockManagerRemoved(SparkListenerBlockManagerRemoved blockManagerRemoved)` Called when an existing block manager has been removed
`void`	`onBlockUpdated(SparkListenerBlockUpdated blockUpdated)` Called when the driver receives a block update info.
`void`	`onEnvironmentUpdate(SparkListenerEnvironmentUpdate environmentUpdate)` Called when environment properties have been updated
`void`	`onEvent(SparkListenerEvent event)`
`void`	`onExecutorAdded(SparkListenerExecutorAdded executorAdded)` Called when the driver registers a new executor.
`void`	`onExecutorBlacklisted(SparkListenerExecutorBlacklisted executorBlacklisted)` Called when the driver blacklists an executor for a Spark application.
`void`	`onExecutorBlacklistedForStage(SparkListenerExecutorBlacklistedForStage executorBlacklistedForStage)` Called when the driver blacklists an executor for a stage.
`void`	`onExecutorMetricsUpdate(SparkListenerExecutorMetricsUpdate executorMetricsUpdate)` Called when the driver receives task metrics from an executor in a heartbeat.
`void`	`onExecutorRemoved(SparkListenerExecutorRemoved executorRemoved)` Called when the driver removes an executor.
`void`	`onExecutorUnblacklisted(SparkListenerExecutorUnblacklisted executorUnblacklisted)` Called when the driver re-enables a previously blacklisted executor.
`void`	`onJobEnd(SparkListenerJobEnd jobEnd)` Called when a job ends
`void`	`onJobStart(SparkListenerJobStart jobStart)` Called when a job starts
`void`	`onNodeBlacklisted(SparkListenerNodeBlacklisted nodeBlacklisted)` Called when the driver blacklists a node for a Spark application.
`void`	`onNodeBlacklistedForStage(SparkListenerNodeBlacklistedForStage nodeBlacklistedForStage)` Called when the driver blacklists a node for a stage.
`void`	`onNodeUnblacklisted(SparkListenerNodeUnblacklisted nodeUnblacklisted)` Called when the driver re-enables a previously blacklisted node.
`void`	`onOtherEvent(SparkListenerEvent event)` Called when other events like SQL-specific events are posted.
`void`	`onSpeculativeTaskSubmitted(SparkListenerSpeculativeTaskSubmitted speculativeTask)` Called when a speculative task is submitted
`void`	`onStageCompleted(SparkListenerStageCompleted stageCompleted)` Called when a stage completes successfully or fails, with information on the completed stage.
`void`	`onStageExecutorMetrics(SparkListenerStageExecutorMetrics executorMetrics)` Called with the peak memory metrics for a given (executor, stage) combination.
`void`	`onStageSubmitted(SparkListenerStageSubmitted stageSubmitted)` Called when a stage is submitted
`void`	`onTaskEnd(SparkListenerTaskEnd taskEnd)` Called when a task ends
`void`	`onTaskGettingResult(SparkListenerTaskGettingResult taskGettingResult)` Called when a task begins remotely fetching its result (will not be called for tasks that do not need to fetch the result remotely).
`void`	`onTaskStart(SparkListenerTaskStart taskStart)` Called when a task starts
`void`	`onUnpersistRDD(SparkListenerUnpersistRDD unpersistRDD)` Called when an RDD is manually unpersisted by the application

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SparkFirehoseListener
```
public SparkFirehoseListener()
```
- Method Detail
  - onEvent
```
public void onEvent(SparkListenerEvent event)
```
  - onStageCompleted
```
public final void onStageCompleted(SparkListenerStageCompleted stageCompleted)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a stage completes successfully or fails, with information on the completed stage.
    
    Specified by:
    
    onStageCompleted in interface SparkListenerInterface
    
    Parameters:
    
    stageCompleted - (undocumented)
  - onStageSubmitted
```
public final void onStageSubmitted(SparkListenerStageSubmitted stageSubmitted)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a stage is submitted
    
    Specified by:
    
    onStageSubmitted in interface SparkListenerInterface
    
    Parameters:
    
    stageSubmitted - (undocumented)
  - onTaskStart
```
public final void onTaskStart(SparkListenerTaskStart taskStart)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a task starts
    
    Specified by:
    
    onTaskStart in interface SparkListenerInterface
    
    Parameters:
    
    taskStart - (undocumented)
  - onTaskGettingResult
```
public final void onTaskGettingResult(SparkListenerTaskGettingResult taskGettingResult)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a task begins remotely fetching its result (will not be called for tasks that do not need to fetch the result remotely).
    
    Specified by:
    
    onTaskGettingResult in interface SparkListenerInterface
    
    Parameters:
    
    taskGettingResult - (undocumented)
  - onTaskEnd
```
public final void onTaskEnd(SparkListenerTaskEnd taskEnd)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a task ends
    
    Specified by:
    
    onTaskEnd in interface SparkListenerInterface
    
    Parameters:
    
    taskEnd - (undocumented)
  - onJobStart
```
public final void onJobStart(SparkListenerJobStart jobStart)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a job starts
    
    Specified by:
    
    onJobStart in interface SparkListenerInterface
    
    Parameters:
    
    jobStart - (undocumented)
  - onJobEnd
```
public final void onJobEnd(SparkListenerJobEnd jobEnd)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a job ends
    
    Specified by:
    
    onJobEnd in interface SparkListenerInterface
    
    Parameters:
    
    jobEnd - (undocumented)
  - onEnvironmentUpdate
```
public final void onEnvironmentUpdate(SparkListenerEnvironmentUpdate environmentUpdate)
```
    Description copied from interface: SparkListenerInterface
    
    Called when environment properties have been updated
    
    Specified by:
    
    onEnvironmentUpdate in interface SparkListenerInterface
    
    Parameters:
    
    environmentUpdate - (undocumented)
  - onBlockManagerAdded
```
public final void onBlockManagerAdded(SparkListenerBlockManagerAdded blockManagerAdded)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a new block manager has joined
    
    Specified by:
    
    onBlockManagerAdded in interface SparkListenerInterface
    
    Parameters:
    
    blockManagerAdded - (undocumented)
  - onBlockManagerRemoved
```
public final void onBlockManagerRemoved(SparkListenerBlockManagerRemoved blockManagerRemoved)
```
    Description copied from interface: SparkListenerInterface
    
    Called when an existing block manager has been removed
    
    Specified by:
    
    onBlockManagerRemoved in interface SparkListenerInterface
    
    Parameters:
    
    blockManagerRemoved - (undocumented)
  - onUnpersistRDD
```
public final void onUnpersistRDD(SparkListenerUnpersistRDD unpersistRDD)
```
    Description copied from interface: SparkListenerInterface
    
    Called when an RDD is manually unpersisted by the application
    
    Specified by:
    
    onUnpersistRDD in interface SparkListenerInterface
    
    Parameters:
    
    unpersistRDD - (undocumented)
  - onApplicationStart
```
public final void onApplicationStart(SparkListenerApplicationStart applicationStart)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the application starts
    
    Specified by:
    
    onApplicationStart in interface SparkListenerInterface
    
    Parameters:
    
    applicationStart - (undocumented)
  - onApplicationEnd
```
public final void onApplicationEnd(SparkListenerApplicationEnd applicationEnd)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the application ends
    
    Specified by:
    
    onApplicationEnd in interface SparkListenerInterface
    
    Parameters:
    
    applicationEnd - (undocumented)
  - onExecutorMetricsUpdate
```
public final void onExecutorMetricsUpdate(SparkListenerExecutorMetricsUpdate executorMetricsUpdate)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver receives task metrics from an executor in a heartbeat.
    
    Specified by:
    
    onExecutorMetricsUpdate in interface SparkListenerInterface
    
    Parameters:
    
    executorMetricsUpdate - (undocumented)
  - onStageExecutorMetrics
```
public final void onStageExecutorMetrics(SparkListenerStageExecutorMetrics executorMetrics)
```
    Description copied from interface: SparkListenerInterface
    
    Called with the peak memory metrics for a given (executor, stage) combination. Note that this is only present when reading from the event log (as in the history server), and is never called in a live application.
    
    Specified by:
    
    onStageExecutorMetrics in interface SparkListenerInterface
    
    Parameters:
    
    executorMetrics - (undocumented)
  - onExecutorAdded
```
public final void onExecutorAdded(SparkListenerExecutorAdded executorAdded)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver registers a new executor.
    
    Specified by:
    
    onExecutorAdded in interface SparkListenerInterface
    
    Parameters:
    
    executorAdded - (undocumented)
  - onExecutorRemoved
```
public final void onExecutorRemoved(SparkListenerExecutorRemoved executorRemoved)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver removes an executor.
    
    Specified by:
    
    onExecutorRemoved in interface SparkListenerInterface
    
    Parameters:
    
    executorRemoved - (undocumented)
  - onExecutorBlacklisted
```
public final void onExecutorBlacklisted(SparkListenerExecutorBlacklisted executorBlacklisted)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver blacklists an executor for a Spark application.
    
    Specified by:
    
    onExecutorBlacklisted in interface SparkListenerInterface
    
    Parameters:
    
    executorBlacklisted - (undocumented)
  - onExecutorBlacklistedForStage
```
public void onExecutorBlacklistedForStage(SparkListenerExecutorBlacklistedForStage executorBlacklistedForStage)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver blacklists an executor for a stage.
    
    Specified by:
    
    onExecutorBlacklistedForStage in interface SparkListenerInterface
    
    Parameters:
    
    executorBlacklistedForStage - (undocumented)
  - onNodeBlacklistedForStage
```
public void onNodeBlacklistedForStage(SparkListenerNodeBlacklistedForStage nodeBlacklistedForStage)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver blacklists a node for a stage.
    
    Specified by:
    
    onNodeBlacklistedForStage in interface SparkListenerInterface
    
    Parameters:
    
    nodeBlacklistedForStage - (undocumented)
  - onExecutorUnblacklisted
```
public final void onExecutorUnblacklisted(SparkListenerExecutorUnblacklisted executorUnblacklisted)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver re-enables a previously blacklisted executor.
    
    Specified by:
    
    onExecutorUnblacklisted in interface SparkListenerInterface
    
    Parameters:
    
    executorUnblacklisted - (undocumented)
  - onNodeBlacklisted
```
public final void onNodeBlacklisted(SparkListenerNodeBlacklisted nodeBlacklisted)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver blacklists a node for a Spark application.
    
    Specified by:
    
    onNodeBlacklisted in interface SparkListenerInterface
    
    Parameters:
    
    nodeBlacklisted - (undocumented)
  - onNodeUnblacklisted
```
public final void onNodeUnblacklisted(SparkListenerNodeUnblacklisted nodeUnblacklisted)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver re-enables a previously blacklisted node.
    
    Specified by:
    
    onNodeUnblacklisted in interface SparkListenerInterface
    
    Parameters:
    
    nodeUnblacklisted - (undocumented)
  - onBlockUpdated
```
public void onBlockUpdated(SparkListenerBlockUpdated blockUpdated)
```
    Description copied from interface: SparkListenerInterface
    
    Called when the driver receives a block update info.
    
    Specified by:
    
    onBlockUpdated in interface SparkListenerInterface
    
    Parameters:
    
    blockUpdated - (undocumented)
  - onSpeculativeTaskSubmitted
```
public void onSpeculativeTaskSubmitted(SparkListenerSpeculativeTaskSubmitted speculativeTask)
```
    Description copied from interface: SparkListenerInterface
    
    Called when a speculative task is submitted
    
    Specified by:
    
    onSpeculativeTaskSubmitted in interface SparkListenerInterface
    
    Parameters:
    
    speculativeTask - (undocumented)
  - onOtherEvent
```
public void onOtherEvent(SparkListenerEvent event)
```
    Description copied from interface: SparkListenerInterface
    
    Called when other events like SQL-specific events are posted.
    
    Specified by:
    
    onOtherEvent in interface SparkListenerInterface
    
    Parameters:
    
    event - (undocumented)

Class SparkFirehoseListener

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

SparkFirehoseListener

Method Detail

onEvent

onStageCompleted

onStageSubmitted

onTaskStart

onTaskGettingResult

onTaskEnd

onJobStart

onJobEnd

onEnvironmentUpdate

onBlockManagerAdded

onBlockManagerRemoved

onUnpersistRDD

onApplicationStart

onApplicationEnd

onExecutorMetricsUpdate

onStageExecutorMetrics

onExecutorAdded

onExecutorRemoved

onExecutorBlacklisted

onExecutorBlacklistedForStage

onNodeBlacklistedForStage

onExecutorUnblacklisted

onNodeBlacklisted

onNodeUnblacklisted

onBlockUpdated

onSpeculativeTaskSubmitted

onOtherEvent