core

Type Members

1. case class ChorusDBSourceInfo(name: String, id: Int) extends Product with Serializable

   

2. case class ChorusUserInfo(userID: String, userName: String, sessionID: String) extends Product with Serializable

   

   ChorusUserInfo

   ChorusUserInfo

   userID

   -- Chorus UserId (should be an integer).

   userName

   -- User Display Name, Chorus user name, not userId.

   sessionID

   -- Chorus Session ID, can be used to make requests to Chorus.

3. trait ExecutionContext extends AnyRef

   

   The context for a plugin execution.

   The context for a plugin execution. This contains information about the underlying platform, such as connection information and/or job submission, the working directory, etc.

4. case class NotebookDetails(readyToExecuteDB: Boolean, readyToExecuteHD: Boolean, useSpark: Boolean, inputsMetadata: Map[String, NotebookIOInfo], outputsMetadata: Map[String, NotebookIOInfo]) extends Product with Serializable

   

5. abstract class NotebookIOForExecution extends AnyRef

   

   Created by emiliedelongueau on 7/4/17.

6. case class NotebookIOInfo(dataSourceName: String, isHdfsInput: Boolean, delimiter: String, quote: String, escape: String, columns: Seq[(String, String)], usesSpark: Boolean, inputName: Option[String]) extends Product with Serializable

   

7. case class NotebookInputDBForExecution(executionLabel: String, tableName: String, schemaName: String, databaseName: String) extends NotebookIOForExecution with Product with Serializable

   

8. case class NotebookInputHDForExecution(executionLabel: String, path: String, header: Boolean, delimiter: Option[String], quote: Option[String], escape: Option[String], columnNames: Seq[String], columnTypes: Seq[String]) extends NotebookIOForExecution with Product with Serializable

   

9. case class NotebookOutputDBForExecution(executionLabel: String, tableName: String, schemaName: String, databaseName: String, overwrite: Boolean) extends NotebookIOForExecution with Product with Serializable

   

10. case class NotebookOutputHDForExecution(executionLabel: String, outputPath: String, delimiter: Option[String], quote: Option[String], escape: Option[String], overwrite: Boolean, storageFormat: Option[String]) extends NotebookIOForExecution with Product with Serializable

    

11. abstract class OperatorGUINode[I <: IOBase, O <: IOBase] extends AnyRef

    

    :: AlpineSdkApi :: Control the behavior of the operator GUI node within the editor.

    :: AlpineSdkApi :: Control the behavior of the operator GUI node within the editor.

    Annotations

    @AlpineSdkApi()

12. trait OperatorListener extends AnyRef

    

    A listener can be used to pass messages from the plugin operators to the UI console.

    A listener can be used to pass messages from the plugin operators to the UI console.

    Annotations

    @AlpineSdkApi()

13. case class OperatorMetadata(name: String, category: String, author: Option[String], version: Int, helpURL: Option[String], icon: Option[OperatorIcon], toolTipText: Option[String], usesJavascript: Boolean) extends Product with Serializable

    

    :: AlpineSdkApi :: Object that is returned by the "get metadata" method in the plugin signature class.

    :: AlpineSdkApi :: Object that is returned by the "get metadata" method in the plugin signature class. And is used by the plugin engine to define how the operator will show up in the GUI.

    name

    the name of the operator as it shows up in the GUI

    category

    the category of operator i.e. "transformation". Used to filter operator in the left hand panel of the workflow GUI.

    author

    the writer of the operator

    version

    the version number of this operator.

    helpURL

    A link to documentation about the operator

    icon

    Name and shape of the custom icon. To use the default icon, use Option.empty().

    toolTipText

    The text of the tool tip which appears when the user hovers over the icon for the operator in the left hand "operators" dropdown.

    Annotations

    @AlpineSdkApi()

14. trait OperatorParameters extends Serializable

    

    :: AlpineSdkApi :: Interface for accessing the parameter values for an operator.

    :: AlpineSdkApi :: Interface for accessing the parameter values for an operator. This is the argument to the 'onExecution' callback function. The developers can extract operator parameter values through this interface.

    Annotations

    @AlpineSdkApi()

15. 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').

    :: 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()

16. abstract class OperatorSignature[G <: OperatorGUINode[_ <: IOBase, _ <: IOBase], R <: OperatorRuntime[_ <: ExecutionContext, _ <: IOBase, _ <: IOBase]] extends AnyRef

    

    :: AlpineSdkApi :: Bundles operator types and metadata used to host the operator in the running system.

    :: AlpineSdkApi :: Bundles operator types and metadata used to host the operator in the running system. Descendants must have a no-arguments constructor

    Annotations

    @AlpineSdkApi()

17. case class OperatorStatus(isValid: Boolean, msg: Option[String], outputMetadata: IOMetadata) extends Product with Serializable

    

    This is the required return type for the onInputOrParameterChange function in OperatorGUINode class.

    This is the required return type for the onInputOrParameterChange function in OperatorGUINode class. If the schemas of connected inputs or selected parameters are invalid, this should be false, along with an optional message about why this is false.

    isValid

    true if the operator is valid. false otherwise.

    msg

    An optional message that will show up in the UI. You can return a message even if the operator is valid.

18. case class PythonNotebook(chorusFile: ChorusFile, userModifiedAt: String, serverStatus: String) extends Product with Serializable

    

19. case class PythonNotebookExecution(notebookId: String, executionId: String, status: String, response: Option[String], error: Option[String], isFinished: Boolean) extends Product with Serializable

    

20. case class WorkflowInfo(workflowID: String) extends Product with Serializable

    
    workflowID

    -- ID of the workfile where the operator is run. This can be usd in the ChorusAPICaller to get the workspace ID.