Class

com.alpine.plugin.core

OperatorRuntime

Related Doc: package core

Permalink

abstract class OperatorRuntime[CTX <: ExecutionContext, I <: IOBase, O <: IOBase] extends AnyRef

:: AlpineSdkApi :: A separate instance of operator plugin runtime gets instantiated for each 'run' of the workflow (or a 'step-run'). When the run is finished, the instance will get deleted/garbage-collected without reuses for subsequent runs.

Annotations
@AlpineSdkApi()
Linear Supertypes
AnyRef, Any
Known Subclasses
DBRuntime, SparkDataFrameRuntime, SparkRuntime, SparkRuntimeWithIOTypedJob, TemplatedSparkDataFrameRuntime
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OperatorRuntime
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OperatorRuntime()

    Permalink

Abstract Value Members

  1. abstract def onExecution(context: CTX, input: I, params: OperatorParameters, listener: OperatorListener): O

    Permalink

    This is the function that gets called when the workflow is run and the operator starts running.

    This is the function that gets called when the workflow is run and the operator starts running.

    context

    Execution context of the operator.

    input

    The input to the operator.

    params

    The parameter values to the operator.

    listener

    The listener object to communicate information back to the console.

    returns

    The output from the execution.

    Annotations
    @throws( ... )

  2. abstract def onStop(context: CTX, listener: OperatorListener): Unit

    Permalink

    This is called when the user clicks on 'stop'.

    This is called when the user clicks on 'stop'. If the operator is currently running, this function gets called while 'onExecution' is still running. So it's the developer's responsibility to properly stop whatever is going within 'onExecution'.

    context

    Execution context of the operator.

    listener

    The listener object to communicate information back to the console.

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. def createVisualResults(context: CTX, input: I, output: O, params: OperatorParameters, listener: OperatorListener): VisualModel

    Permalink

    This is called to generate the visual output for the results console.

    This is called to generate the visual output for the results console. If the developer does not override it, we try OperatorGUINode#onOutputVisualization, which predated this, so we keep for compatibility.

    context

    Execution context of the operator.

    input

    The input to the operator.

    output

    The output from the execution.

    params

    The parameter values to the operator.

    listener

    The listener object to communicate information back to the console.

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

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

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

  19. final def wait(arg0: Long, arg1: Int): Unit

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

  20. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped