Class SinkProgress

Object
org.apache.spark.sql.streaming.SinkProgress
All Implemented Interfaces:
Serializable, scala.Serializable

public class SinkProgress extends Object implements scala.Serializable
Information about progress made for a sink in the execution of a StreamingQuery during a trigger. See StreamingQueryProgress for more information.

param: description Description of the source corresponding to this status. param: numOutputRows Number of rows written to the sink or -1 for Continuous Mode (temporarily) or Sink V1 (until decommissioned).

Since:
2.1.0
See Also:
  • Method Details

    • DEFAULT_NUM_OUTPUT_ROWS

      public static long DEFAULT_NUM_OUTPUT_ROWS()
    • apply

      public static SinkProgress apply(String description, scala.Option<Object> numOutputRows, Map<String,String> metrics)
    • description

      public String description()
    • numOutputRows

      public long numOutputRows()
    • metrics

      public Map<String,String> metrics()
    • json

      public String json()
      The compact JSON representation of this progress.
    • prettyJson

      public String prettyJson()
      The pretty (i.e. indented) JSON representation of this progress.
    • toString

      public String toString()
      Overrides:
      toString in class Object