org.apache.spark.sql.streaming

Class StreamingQueryStatus

Object

org.apache.spark.sql.streaming.StreamingQueryStatus

public class StreamingQueryStatus
extends Object

:: Experimental :: A class used to report information about the progress of a StreamingQuery.

param: name Name of the query. This name is unique across all active queries. param: id Id of the query. This id is unique across all queries that have been started in the current process. param: timestamp Timestamp (ms) of when this query was generated. param: inputRate Current rate (rows/sec) at which data is being generated by all the sources. param: processingRate Current rate (rows/sec) at which the query is processing data from all the sources. param: latency Current average latency between the data being available in source and the sink writing the corresponding output. param: sourceStatuses Current statuses of the sources. param: sinkStatus Current status of the sink. param: triggerDetails Low-level details of the currently active trigger (e.g. number of rows processed in trigger, latency of intermediate steps, etc.). If no trigger is active, then it will have details of the last completed trigger.

Since:

2.0.0

Method Summary

Methods

Modifier and Type	Method and Description
static StreamingQueryStatus	apply(String name, long id, long timestamp, double inputRate, double processingRate, scala.Option<Object> latency, SourceStatus[] sourceStatuses, SinkStatus sinkStatus, scala.collection.immutable.Map<String,String> triggerDetails)
long	id()
static String	indent(scala.collection.Iterable<String> strings)
static String	indent(String string)
double	inputRate()
String	json() The compact JSON representation of this status.
scala.Option<Object>	latency()
String	name()
String	prettyJson() The pretty (i.e.
double	processingRate()
SinkStatus	sinkStatus()
SourceStatus[]	sourceStatuses()
static StreamingQueryStatus	testStatus() Create an instance of status for python testing
long	timestamp()
String	toString()
java.util.Map<String,String>	triggerDetails()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

apply

public static StreamingQueryStatus apply(String name,
                         long id,
                         long timestamp,
                         double inputRate,
                         double processingRate,
                         scala.Option<Object> latency,
                         SourceStatus[] sourceStatuses,
                         SinkStatus sinkStatus,
                         scala.collection.immutable.Map<String,String> triggerDetails)

indent

public static String indent(scala.collection.Iterable<String> strings)

indent

public static String indent(String string)

testStatus

public static StreamingQueryStatus testStatus()

Create an instance of status for python testing

name

public String name()

id

public long id()

timestamp

public long timestamp()

inputRate

public double inputRate()

processingRate

public double processingRate()

latency

public scala.Option<Object> latency()

sourceStatuses

public SourceStatus[] sourceStatuses()

sinkStatus

public SinkStatus sinkStatus()

triggerDetails

public java.util.Map<String,String> triggerDetails()

json

public String json()

The compact JSON representation of this status.

prettyJson

public String prettyJson()

The pretty (i.e. indented) JSON representation of this status.

toString

public String toString()

Overrides:

toString in class Object