Developer API

org.apache.spark.streaming.scheduler

Class BatchInfo

java.lang.Object

org.apache.spark.streaming.scheduler.BatchInfo

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public class BatchInfo
extends java.lang.Object
implements scala.Product, scala.Serializable

Class having information on completed batches. param: batchTime Time of the batch param: streamIdToInputInfo A map of input stream id to its input info param: submissionTime Clock time of when jobs of this batch was submitted to the streaming scheduler queue param: processingStartTime Clock time of when the first job of this batch started processing param: processingEndTime Clock time of when the last job of this batch finished processing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BatchInfo(Time batchTime, scala.collection.immutable.Map<java.lang.Object,StreamInputInfo> streamIdToInputInfo, long submissionTime, scala.Option<java.lang.Object> processingStartTime, scala.Option<java.lang.Object> processingEndTime)

Method Summary

Methods

Modifier and Type	Method and Description
Time	batchTime()
long	numRecords() The number of recorders received by the receivers in this batch.
scala.Option<java.lang.Object>	processingDelay() Time taken for the all jobs of this batch to finish processing from the time they started processing.
scala.Option<java.lang.Object>	processingEndTime()
scala.Option<java.lang.Object>	processingStartTime()
scala.Option<java.lang.Object>	schedulingDelay() Time taken for the first job of this batch to start processing from the time this batch was submitted to the streaming scheduler.
scala.collection.immutable.Map<java.lang.Object,StreamInputInfo>	streamIdToInputInfo()
scala.collection.immutable.Map<java.lang.Object,java.lang.Object>	streamIdToNumRecords()
long	submissionTime()
scala.Option<java.lang.Object>	totalDelay() Time taken for all the jobs of this batch to finish processing from the time they were submitted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

BatchInfo

public BatchInfo(Time batchTime,
         scala.collection.immutable.Map<java.lang.Object,StreamInputInfo> streamIdToInputInfo,
         long submissionTime,
         scala.Option<java.lang.Object> processingStartTime,
         scala.Option<java.lang.Object> processingEndTime)

Method Detail

batchTime

public Time batchTime()

streamIdToInputInfo

public scala.collection.immutable.Map<java.lang.Object,StreamInputInfo> streamIdToInputInfo()

submissionTime

public long submissionTime()

processingStartTime

public scala.Option<java.lang.Object> processingStartTime()

processingEndTime

public scala.Option<java.lang.Object> processingEndTime()

streamIdToNumRecords

public scala.collection.immutable.Map<java.lang.Object,java.lang.Object> streamIdToNumRecords()

schedulingDelay

public scala.Option<java.lang.Object> schedulingDelay()

Time taken for the first job of this batch to start processing from the time this batch was submitted to the streaming scheduler. Essentially, it is processingStartTime - submissionTime.

Returns:

(undocumented)

processingDelay

public scala.Option<java.lang.Object> processingDelay()

Time taken for the all jobs of this batch to finish processing from the time they started processing. Essentially, it is processingEndTime - processingStartTime.

Returns:

(undocumented)

totalDelay

public scala.Option<java.lang.Object> totalDelay()

Time taken for all the jobs of this batch to finish processing from the time they were submitted. Essentially, it is processingDelay + schedulingDelay.

Returns:

(undocumented)

numRecords

public long numRecords()

The number of recorders received by the receivers in this batch.

Returns:

(undocumented)