Class

com.salesforce.op

OpApp

Related Doc: package op

Permalink

abstract class OpApp extends AnyRef

A simple command line app for running an OpWorkflow with Spark. A user needs to implement a run function.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpApp
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OpApp()

    Permalink

Abstract Value Members

  1. abstract def run(runType: OpWorkflowRunType, opParams: OpParams)(implicit spark: SparkSession, streaming: StreamingContext): Unit

    Permalink

    The main function to run your OpWorkflow.

    The main function to run your OpWorkflow. The easiest way is to create an OpWorkflowRunner and run it.

    runType

    run type

    opParams

    parameters injected at runtime

    spark

    spark session which runs the workflow

    streaming

    spark streaming context which runs the workflow

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def appName: String

    Permalink

    Application name (gets the value of 'spark.app.name' parameter).

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def defaultAppName: String

    Permalink

    Default application name - to be used if 'spark.app.name' parameter is not set.

  8. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def kryoRegistrator: Class[_ <: OpKryoRegistrator]

    Permalink

    Kryo registrar to use when creating a SparkConf.

    Kryo registrar to use when creating a SparkConf.

    First create your own registrator by extending the OpKryoRegistrator and then register your new classes by overriding OpKryoRegistrator.registerCustomClasses.

    Then override this method to set your registrator with Spark.

  15. def main(args: Array[String]): Unit

    Permalink

    The main method - loads the params and runs the workflow according to parameter settings.

    The main method - loads the params and runs the workflow according to parameter settings.

    args

    command line args to be parsed into OpWorkflowRunnerConfig

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def parseArgs(args: Array[String]): (OpWorkflowRunType, OpParams)

    Permalink

    Parse command line arguments as OpParams.

    Parse command line arguments as OpParams.

    args

    command line arguments

    returns

    run type and OpParams

  20. def sparkConf: SparkConf

    Permalink

    Configuration for a Spark application.

    Configuration for a Spark application. Used to set various Spark parameters as key-value pairs.

    returns

    SparkConf

  21. def sparkSession: SparkSession

    Permalink

    Gets/creates a Spark Session.

  22. def sparkStreamingContext(batchDuration: Duration): StreamingContext

    Permalink

    Gets/creates a Spark Streaming Context.

    Gets/creates a Spark Streaming Context.

    batchDuration

    the time interval at which streaming data will be divided into batches

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped