org.apache.spark.streaming.scheduler

Class StreamInputInfo

Object

org.apache.spark.streaming.scheduler.StreamInputInfo

All Implemented Interfaces:

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

public class StreamInputInfo
extends Object
implements scala.Product, scala.Serializable

:: DeveloperApi :: Track the information of input stream at specified batch time.

param: inputStreamId the input stream id param: numRecords the number of records in a batch param: metadata metadata for this batch. It should contain at least one standard field named "Description" which maps to the content that will be shown in the UI.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StreamInputInfo(int inputStreamId, long numRecords, scala.collection.immutable.Map<String,Object> metadata)

Method Summary

Modifier and Type	Method and Description
int	inputStreamId()
static String	METADATA_KEY_DESCRIPTION() The key for description in StreamInputInfo.metadata.
scala.collection.immutable.Map<String,Object>	metadata()
scala.Option<String>	metadataDescription()
long	numRecords()

Methods inherited from class Object

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

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

StreamInputInfo

public StreamInputInfo(int inputStreamId,
                       long numRecords,
                       scala.collection.immutable.Map<String,Object> metadata)

Method Detail

METADATA_KEY_DESCRIPTION

public static String METADATA_KEY_DESCRIPTION()

The key for description in StreamInputInfo.metadata.

Returns:

(undocumented)

inputStreamId

public int inputStreamId()

numRecords

public long numRecords()

metadata

public scala.collection.immutable.Map<String,Object> metadata()

metadataDescription

public scala.Option<String> metadataDescription()