object StreamingContext extends Logging
StreamingContext object contains a number of utility functions related to the StreamingContext class.
- Annotations
- @deprecated
- Deprecated
(Since version Spark 3.4.0) DStream is deprecated. Migrate to Structured Streaming.
- Source
- StreamingContext.scala
- Alphabetic
- By Inheritance
- StreamingContext
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
def
getActive(): Option[StreamingContext]
Get the currently active context, if there is one.
Get the currently active context, if there is one. Active means started but not stopped.
-
def
getActiveOrCreate(checkpointPath: String, creatingFunc: () ⇒ StreamingContext, hadoopConf: Configuration = SparkHadoopUtil.get.conf, createOnError: Boolean = false): StreamingContext
Either get the currently active StreamingContext (that is, started but not stopped), OR recreate a StreamingContext from checkpoint data in the given path.
Either get the currently active StreamingContext (that is, started but not stopped), OR recreate a StreamingContext from checkpoint data in the given path. If checkpoint data does not exist in the provided, then create a new StreamingContext by calling the provided
creatingFunc
.- checkpointPath
Checkpoint directory used in an earlier StreamingContext program
- creatingFunc
Function to create a new StreamingContext
- hadoopConf
Optional Hadoop configuration if necessary for reading from the file system
- createOnError
Optional, whether to create a new StreamingContext if there is an error in reading checkpoint data. By default, an exception will be thrown on error.
-
def
getActiveOrCreate(creatingFunc: () ⇒ StreamingContext): StreamingContext
Either return the "active" StreamingContext (that is, started but not stopped), or create a new StreamingContext that is
Either return the "active" StreamingContext (that is, started but not stopped), or create a new StreamingContext that is
- creatingFunc
Function to create a new StreamingContext
-
def
getOrCreate(checkpointPath: String, creatingFunc: () ⇒ StreamingContext, hadoopConf: Configuration = SparkHadoopUtil.get.conf, createOnError: Boolean = false): StreamingContext
Either recreate a StreamingContext from checkpoint data or create a new StreamingContext.
Either recreate a StreamingContext from checkpoint data or create a new StreamingContext. If checkpoint data exists in the provided
checkpointPath
, then StreamingContext will be recreated from the checkpoint data. If the data does not exist, then the StreamingContext will be created by called the providedcreatingFunc
.- checkpointPath
Checkpoint directory used in an earlier StreamingContext program
- creatingFunc
Function to create a new StreamingContext
- hadoopConf
Optional Hadoop configuration if necessary for reading from the file system
- createOnError
Optional, whether to create a new StreamingContext if there is an error in reading checkpoint data. By default, an exception will be thrown on error.
-
def
jarOfClass(cls: Class[_]): Option[String]
Find the JAR from which a given class was loaded, to make it easy for users to pass their JARs to StreamingContext.