StreamingQueryStatus (Spark 3.5.5 JavaDoc) (original) (raw)

• Object

• • org.apache.spark.sql.streaming.StreamingQueryStatus

• All Implemented Interfaces:
  java.io.Serializable

public class StreamingQueryStatus
extends Object
implements scala.Serializable
Reports information about the instantaneous status of a streaming query.
param: message A human readable description of what the stream is currently doing. param: isDataAvailable True when there is new data to be processed. Doesn't apply to ContinuousExecution where it is always false. param: isTriggerActive True when the trigger is actively firing, false when waiting for the next trigger time. Doesn't apply to ContinuousExecution where it is always false.
Since:
2.1.0
See Also:
Serialized Form

• • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method and Description
  boolean	isDataAvailable()
  boolean	isTriggerActive()
  String	json() The compact JSON representation of this status.
  String	message()
  String	prettyJson() The pretty (i.e.
  String	toString()

     * ### Methods inherited from class Object  
     `equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

• • Method Detail

     * #### isDataAvailable  
     public boolean isDataAvailable()  
     * #### isTriggerActive  
     public boolean isTriggerActive()  
     * #### json  
     public String json()  
     The compact JSON representation of this status.  
     * #### message  
     public String message()  
     * #### prettyJson  
     public String prettyJson()  
     The pretty (i.e. indented) JSON representation of this status.  
     * #### toString  
     public String toString()  
     Overrides:  
     `toString` in class `Object`