Package org.apache.spark.sql.streaming

Class StreamingQueryStatus

Object
org.apache.spark.sql.streaming.StreamingQueryStatus
All Implemented Interfaces:
Serializable
public class StreamingQueryStatus extends Object implements 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:

  • Method Details

    • 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