Class

com.alpine.plugin.core.spark

SparkIOTypedPluginJob

Related Doc: package spark

Permalink

abstract class SparkIOTypedPluginJob[I, O] extends AnyRef

:: AlpineSdkApi ::

This is the Spark Job class. It gets submitted to the cluster by a Runtime class which is a derivative of SparkRuntime. The 'onExecution method' in this class serves as the driver function for the Spark Job.

It handles the serialization/deserialization of Inputs and Outputs. It enables you to directly work with IOBase objects without needing to implement your own (de)serialization logic. This class is intended to be coupled with SparkRuntimeWithIOTypedJob, a descendant of SparkRuntime that takes a descendant of this class as a generic parameter.

Note: It is possible to use this class with a runtime class that extends the generic SparkRuntime class (rather than the SparkRuntimeWithIOTypedJob class). However, by using SparkRuntimeWithIOTypedJob and overriding the onExecution method, you can get many of the benefits of the class while implementing more complex behavior. In taking the later approach you can use the SparkRuntimeWithIOTypedJob implementation of the 'onExecution' method as a utility function for submitting the Spark job by calling super.onExecution.

I

input type of your plugin must be consistent with the SparkRuntime implementation's type parameters.

O

output type of your plugin

Annotations
@AlpineSdkApi()
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SparkIOTypedPluginJob
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SparkIOTypedPluginJob()

    Permalink

Abstract Value Members

  1. abstract def onExecution(alpineSparkEnvironment: AlpineSparkEnvironment, input: I, operatorParameters: OperatorParameters, listener: OperatorListener): O

    Permalink

    The driver function for the Spark job.

    The driver function for the Spark job. Unlike the corresponding function in the parent class, this function allows you to work with IOBase types directly. YOU MUST Override one of the two 'onExecution' methods.

    alpineSparkEnvironment

    Information about the spark job including the Spark session (unified spark context) created when job was submitted

    input

    the ioBase object which you have defined as the input to your plugin. For example, if the GUI node of the plugin takes an HDFSTabularDataset, this input parameter will be that dataset.

    operatorParameters

    -the parameter values set in the GUI node. Their value can be accessed via the "key" defined for each parameter added to the OperatorDialog in the GUI node.

    listener

    a listener object which allows you to send messages to the Alpine GUI during the Spark job

    returns

    the output of your plugin

    Annotations
    @throws( ... )

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped