spark.streaming.dstream

InputDStream

abstract class InputDStream[T] extends DStream[T]

This is the abstract base class for all input streams. This class provides to methods start() and stop() which called by the scheduler to start and stop receiving data/ Input streams that can generated RDDs from new data just by running a service on the driver node (that is, without running a receiver onworker nodes) can be implemented by directly subclassing this InputDStream. For example, FileInputDStream, a subclass of InputDStream, monitors a HDFS directory for new files and generates RDDs on the new files. For implementing input streams that requires running a receiver on the worker nodes, use NetworkInputDStream as the parent class.

Linear Supertypes
DStream[T], Logging, Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. InputDStream
  2. DStream
  3. Logging
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new InputDStream(ssc_: StreamingContext)(implicit arg0: ClassManifest[T])

Abstract Value Members

  1. abstract def compute(validTime: Time): Option[RDD[T]]

    Method that generates a RDD for the given time

    Method that generates a RDD for the given time

    Definition Classes
    DStream
  2. abstract def start(): Unit

    Method called to start receiving data.

    Method called to start receiving data. Subclasses must implement this method.

  3. abstract def stop(): Unit

    Method called to stop receiving data.

    Method called to stop receiving data. Subclasses must implement this method.

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addMetadata(metadata: Any): Unit

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def cache(): DStream[T]

    Persist RDDs of this DStream with the default storage level (MEMORY_ONLY_SER)

    Persist RDDs of this DStream with the default storage level (MEMORY_ONLY_SER)

    Definition Classes
    DStream
  9. def checkpoint(interval: Duration): DStream[T]

    Enable periodic checkpointing of RDDs of this DStream

    Enable periodic checkpointing of RDDs of this DStream

    interval

    Time interval after which generated RDD will be checkpointed

    Definition Classes
    DStream
  10. val checkpointData: DStreamCheckpointData[T]

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  11. var checkpointDuration: Duration

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  12. def clearOldMetadata(time: Time): Unit

    Clear metadata that are older than rememberDuration of this DStream.

    Clear metadata that are older than rememberDuration of this DStream. This is an internal method that should not be called directly. This default implementation clears the old generated RDDs. Subclasses of DStream may override this to clear their own metadata along with the generated RDDs.

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  13. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  14. def context: StreamingContext

    Return the StreamingContext associated with this DStream

    Return the StreamingContext associated with this DStream

    Definition Classes
    DStream
  15. def count(): DStream[Long]

    Return a new DStream in which each RDD has a single element generated by counting each RDD of this DStream.

    Return a new DStream in which each RDD has a single element generated by counting each RDD of this DStream.

    Definition Classes
    DStream
  16. def countByValue(numPartitions: Int = ssc.sc.defaultParallelism): DStream[(T, Long)]

    Return a new DStream in which each RDD contains the counts of each distinct value in each RDD of this DStream.

    Return a new DStream in which each RDD contains the counts of each distinct value in each RDD of this DStream. Hash partitioning is used to generate the RDDs with numPartitions partitions (Spark's default number of partitions if numPartitions not specified).

    Definition Classes
    DStream
  17. def countByValueAndWindow(windowDuration: Duration, slideDuration: Duration, numPartitions: Int = ssc.sc.defaultParallelism): DStream[(T, Long)]

    Return a new DStream in which each RDD contains the count of distinct elements in RDDs in a sliding window over this DStream.

    Return a new DStream in which each RDD contains the count of distinct elements in RDDs in a sliding window over this DStream. Hash partitioning is used to generate the RDDs with numPartitions partitions (Spark's default number of partitions if numPartitions not specified).

    windowDuration

    width of the window; must be a multiple of this DStream's batching interval

    slideDuration

    sliding interval of the window (i.e., the interval after which the new DStream will generate RDDs); must be a multiple of this DStream's batching interval

    numPartitions

    number of partitions of each RDD in the new DStream.

    Definition Classes
    DStream
  18. def countByWindow(windowDuration: Duration, slideDuration: Duration): DStream[Long]

    Return a new DStream in which each RDD has a single element generated by counting the number of elements in a sliding window over this DStream.

    Return a new DStream in which each RDD has a single element generated by counting the number of elements in a sliding window over this DStream. Hash partitioning is used to generate the RDDs with Spark's default number of partitions.

    windowDuration

    width of the window; must be a multiple of this DStream's batching interval

    slideDuration

    sliding interval of the window (i.e., the interval after which the new DStream will generate RDDs); must be a multiple of this DStream's batching interval

    Definition Classes
    DStream
  19. def dependencies: List[Nothing]

    List of parent DStreams on which this DStream depends on

    List of parent DStreams on which this DStream depends on

    Definition Classes
    InputDStreamDStream
  20. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  22. def filter(filterFunc: (T) ⇒ Boolean): DStream[T]

    Return a new DStream containing only the elements that satisfy a predicate.

    Return a new DStream containing only the elements that satisfy a predicate.

    Definition Classes
    DStream
  23. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  24. def flatMap[U](flatMapFunc: (T) ⇒ Traversable[U])(implicit arg0: ClassManifest[U]): DStream[U]

    Return a new DStream by applying a function to all elements of this DStream, and then flattening the results

    Return a new DStream by applying a function to all elements of this DStream, and then flattening the results

    Definition Classes
    DStream
  25. def foreach(foreachFunc: (RDD[T], Time) ⇒ Unit): Unit

    Apply a function to each RDD in this DStream.

    Apply a function to each RDD in this DStream. This is an output operator, so this DStream will be registered as an output stream and therefore materialized.

    Definition Classes
    DStream
  26. def foreach(foreachFunc: (RDD[T]) ⇒ Unit): Unit

    Apply a function to each RDD in this DStream.

    Apply a function to each RDD in this DStream. This is an output operator, so this DStream will be registered as an output stream and therefore materialized.

    Definition Classes
    DStream
  27. def generateJob(time: Time): Option[Job]

    Generate a SparkStreaming job for the given time.

    Generate a SparkStreaming job for the given time. This is an internal method that should not be called directly. This default implementation creates a job that materializes the corresponding RDD. Subclasses of DStream may override this to generate their own jobs.

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  28. var generatedRDDs: HashMap[Time, RDD[T]]

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  29. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  30. def getOrCompute(time: Time): Option[RDD[T]]

    Retrieve a precomputed RDD of this DStream, or computes the RDD.

    Retrieve a precomputed RDD of this DStream, or computes the RDD. This is an internal method that should not be called directly.

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  31. def glom(): DStream[Array[T]]

    Return a new DStream in which each RDD is generated by applying glom() to each RDD of this DStream.

    Return a new DStream in which each RDD is generated by applying glom() to each RDD of this DStream. Applying glom() to an RDD coalesces all elements within each partition into an array.

    Definition Classes
    DStream
  32. var graph: DStreamGraph

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  33. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  34. def initLogging(): Unit

    Attributes
    protected
    Definition Classes
    Logging
  35. def initialize(time: Time): Unit

    Initialize the DStream by setting the "zero" time, based on which the validity of future times is calculated.

    Initialize the DStream by setting the "zero" time, based on which the validity of future times is calculated. This method also recursively initializes its parent DStreams.

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  36. def isInitialized: Boolean

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  37. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  38. def isTimeValid(time: Time): Boolean

    Checks whether the 'time' is valid wrt slideDuration for generating RDD.

    Checks whether the 'time' is valid wrt slideDuration for generating RDD. Additionally it also ensures valid times are in strictly increasing order. This ensures that InputDStream.compute() is called strictly on increasing times.

    Attributes
    protected
    Definition Classes
    InputDStreamDStream
  39. var lastValidTime: Time

  40. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging
  41. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  42. def logDebug(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  43. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  44. def logError(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  45. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  46. def logInfo(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  47. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  48. def logTrace(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  49. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  50. def logWarning(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  51. def map[U](mapFunc: (T) ⇒ U)(implicit arg0: ClassManifest[U]): DStream[U]

    Return a new DStream by applying a function to all elements of this DStream.

    Return a new DStream by applying a function to all elements of this DStream.

    Definition Classes
    DStream
  52. def mapPartitions[U](mapPartFunc: (Iterator[T]) ⇒ Iterator[U], preservePartitioning: Boolean)(implicit arg0: ClassManifest[U]): DStream[U]

    Return a new DStream in which each RDD is generated by applying mapPartitions() to each RDDs of this DStream.

    Return a new DStream in which each RDD is generated by applying mapPartitions() to each RDDs of this DStream. Applying mapPartitions() to an RDD applies a function to each partition of the RDD.

    Definition Classes
    DStream
  53. val mustCheckpoint: Boolean

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  54. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  55. final def notify(): Unit

    Definition Classes
    AnyRef
  56. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  57. def parentRememberDuration: Duration

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  58. def persist(): DStream[T]

    Persist RDDs of this DStream with the default storage level (MEMORY_ONLY_SER)

    Persist RDDs of this DStream with the default storage level (MEMORY_ONLY_SER)

    Definition Classes
    DStream
  59. def persist(level: StorageLevel): DStream[T]

    Persist the RDDs of this DStream with the given storage level

    Persist the RDDs of this DStream with the given storage level

    Definition Classes
    DStream
  60. def print(): Unit

    Print the first ten elements of each RDD generated in this DStream.

    Print the first ten elements of each RDD generated in this DStream. This is an output operator, so this DStream will be registered as an output stream and there materialized.

    Definition Classes
    DStream
  61. def reduce(reduceFunc: (T, T) ⇒ T): DStream[T]

    Return a new DStream in which each RDD has a single element generated by reducing each RDD of this DStream.

    Return a new DStream in which each RDD has a single element generated by reducing each RDD of this DStream.

    Definition Classes
    DStream
  62. def reduceByWindow(reduceFunc: (T, T) ⇒ T, invReduceFunc: (T, T) ⇒ T, windowDuration: Duration, slideDuration: Duration): DStream[T]

    Return a new DStream in which each RDD has a single element generated by reducing all elements in a sliding window over this DStream.

    Return a new DStream in which each RDD has a single element generated by reducing all elements in a sliding window over this DStream. However, the reduction is done incrementally using the old window's reduced value :

    1. reduce the new values that entered the window (e.g., adding new counts) 2. "inverse reduce" the old values that left the window (e.g., subtracting old counts) This is more efficient than reduceByWindow without "inverse reduce" function. However, it is applicable to only "invertible reduce functions".
    reduceFunc

    associative reduce function

    invReduceFunc

    inverse reduce function

    windowDuration

    width of the window; must be a multiple of this DStream's batching interval

    slideDuration

    sliding interval of the window (i.e., the interval after which the new DStream will generate RDDs); must be a multiple of this DStream's batching interval

    Definition Classes
    DStream
  63. def reduceByWindow(reduceFunc: (T, T) ⇒ T, windowDuration: Duration, slideDuration: Duration): DStream[T]

    Return a new DStream in which each RDD has a single element generated by reducing all elements in a sliding window over this DStream.

    Return a new DStream in which each RDD has a single element generated by reducing all elements in a sliding window over this DStream.

    reduceFunc

    associative reduce function

    windowDuration

    width of the window; must be a multiple of this DStream's batching interval

    slideDuration

    sliding interval of the window (i.e., the interval after which the new DStream will generate RDDs); must be a multiple of this DStream's batching interval

    Definition Classes
    DStream
  64. def register(): Unit

    Definition Classes
    DStream
  65. def remember(duration: Duration): Unit

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  66. var rememberDuration: Duration

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  67. def restoreCheckpointData(): Unit

    Restore the RDDs in generatedRDDs from the checkpointData.

    Restore the RDDs in generatedRDDs from the checkpointData. This is an internal method that should not be called directly. This is a default implementation that recreates RDDs from the checkpoint file names stored in checkpointData. Subclasses of DStream that override the updateCheckpointData() method would also need to override this method.

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  68. def saveAsObjectFiles(prefix: String, suffix: String = ""): Unit

    Save each RDD in this DStream as a Sequence file of serialized objects.

    Save each RDD in this DStream as a Sequence file of serialized objects. The file name at each batch interval is generated based on prefix and suffix: "prefix-TIME_IN_MS.suffix".

    Definition Classes
    DStream
  69. def saveAsTextFiles(prefix: String, suffix: String = ""): Unit

    Save each RDD in this DStream as at text file, using string representation of elements.

    Save each RDD in this DStream as at text file, using string representation of elements. The file name at each batch interval is generated based on prefix and suffix: "prefix-TIME_IN_MS.suffix".

    Definition Classes
    DStream
  70. def setContext(s: StreamingContext): Unit

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  71. def setGraph(g: DStreamGraph): Unit

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  72. def slice(fromTime: Time, toTime: Time): Seq[RDD[T]]

    Return all the RDDs between 'fromTime' to 'toTime' (both included)

    Return all the RDDs between 'fromTime' to 'toTime' (both included)

    Definition Classes
    DStream
  73. def slice(interval: Interval): Seq[RDD[T]]

    Return all the RDDs defined by the Interval object (both end times included)

    Return all the RDDs defined by the Interval object (both end times included)

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  74. def slideDuration: Duration

    Time interval after which the DStream generates a RDD

    Time interval after which the DStream generates a RDD

    Definition Classes
    InputDStreamDStream
  75. var ssc: StreamingContext

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  76. var storageLevel: StorageLevel

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  77. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  78. def toString(): String

    Definition Classes
    AnyRef → Any
  79. def transform[U](transformFunc: (RDD[T], Time) ⇒ RDD[U])(implicit arg0: ClassManifest[U]): DStream[U]

    Return a new DStream in which each RDD is generated by applying a function on each RDD of this DStream.

    Return a new DStream in which each RDD is generated by applying a function on each RDD of this DStream.

    Definition Classes
    DStream
  80. def transform[U](transformFunc: (RDD[T]) ⇒ RDD[U])(implicit arg0: ClassManifest[U]): DStream[U]

    Return a new DStream in which each RDD is generated by applying a function on each RDD of this DStream.

    Return a new DStream in which each RDD is generated by applying a function on each RDD of this DStream.

    Definition Classes
    DStream
  81. def union(that: DStream[T]): DStream[T]

    Return a new DStream by unifying data of another DStream with this DStream.

    Return a new DStream by unifying data of another DStream with this DStream.

    that

    Another DStream having the same slideDuration as this DStream.

    Definition Classes
    DStream
  82. def updateCheckpointData(currentTime: Time): Unit

    Refresh the list of checkpointed RDDs that will be saved along with checkpoint of this stream.

    Refresh the list of checkpointed RDDs that will be saved along with checkpoint of this stream. This is an internal method that should not be called directly. This is a default implementation that saves only the file names of the checkpointed RDDs to checkpointData. Subclasses of DStream (especially those of InputDStream) may override this method to save custom checkpoint data.

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  83. def validate(): Unit

    Attributes
    protected[streaming]
    Definition Classes
    DStream
  84. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  85. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  86. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  87. def window(windowDuration: Duration, slideDuration: Duration): DStream[T]

    Return a new DStream in which each RDD contains all the elements in seen in a sliding window of time over this DStream.

    Return a new DStream in which each RDD contains all the elements in seen in a sliding window of time over this DStream.

    windowDuration

    width of the window; must be a multiple of this DStream's batching interval

    slideDuration

    sliding interval of the window (i.e., the interval after which the new DStream will generate RDDs); must be a multiple of this DStream's batching interval

    Definition Classes
    DStream
  88. def window(windowDuration: Duration): DStream[T]

    Return a new DStream in which each RDD contains all the elements in seen in a sliding window of time over this DStream.

    Return a new DStream in which each RDD contains all the elements in seen in a sliding window of time over this DStream. The new DStream generates RDDs with the same interval as this DStream.

    windowDuration

    width of the window; must be a multiple of this DStream's interval.

    Definition Classes
    DStream
  89. var zeroTime: Time

    Attributes
    protected[streaming]
    Definition Classes
    DStream

Inherited from DStream[T]

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any