com.alpine.plugin.test.mock

ChorusAPICallerMock

class ChorusAPICallerMock extends ChorusAPICaller

Linear Supertypes
ChorusAPICaller, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ChorusAPICallerMock
  2. ChorusAPICaller
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChorusAPICallerMock(workfiles: Seq[ChorusFileInWorkspaceMock])

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createOrUpdateChorusFile(workspaceId: String, file: File, overwrite: Boolean): Try[ChorusFile]

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  9. final def eq(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    AnyRef → Any
  13. def getNotebookDetails(notebookID: String): Try[NotebookDetails]

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  14. def getNotebookExecutionStatus(notebook_id: String, execution_id: String): Try[PythonNotebookExecution]

    Queries the status of the notebook execution.

    Queries the status of the notebook execution.

    notebook_id

    Id of the notebook

    execution_id

    Id of the execution to retrieve from PythonNotebookExecution response.

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  15. def getWorkfileDBDataSources(workfileID: String): Try[List[ChorusDBSourceInfo]]

    Lists the DB connection names (as registered in Chorus 'Data' tab) and ids for a specific workflow

    Lists the DB connection names (as registered in Chorus 'Data' tab) and ids for a specific workflow

    workfileID

    id of the current workflow

    returns

    The list of Chorus DB data sources ChorusDBSourceInfo the workflow is connected to.

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  16. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  21. def readWorkfileAsText(workfile: ChorusFile): Try[String]

    Equivalent to readWorkfileAsText(workfile.id)

    Equivalent to readWorkfileAsText(workfile.id)

    workfile

    The file to download.

    returns

    The contents of the file as a string.

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  22. def readWorkfileAsText(workFileID: String): Try[String]

    Downloads the workfile with the referenced id from Chorus, and reads the content as a text file.

    Downloads the workfile with the referenced id from Chorus, and reads the content as a text file.

    workFileID

    Id of the file to download.

    returns

    The contents of the file as a string.

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  23. def readWorkfileInputStream[R](workfile: ChorusFile, readFunction: (InputStream) ⇒ R): Try[R]

    Equivalent to readFunction)

    Equivalent to readFunction)

    R

    The return type of the read function.

    workfile

    The file to download.

    readFunction

    The function to apply to the file input stream.

    returns

    The output of the readFunction applied to the downloaded file input stream.

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  24. def readWorkfileInputStream[R](workFileID: String, readFunction: (InputStream) ⇒ R): Try[R]

    Gets the workfile from Chorus as an input stream, applies the read function, closes the input stream and then returns the result of the read function.

    Gets the workfile from Chorus as an input stream, applies the read function, closes the input stream and then returns the result of the read function.

    R

    The return type of the read function.

    workFileID

    Id of the file to download.

    readFunction

    The function to apply to the file input stream.

    returns

    The output of the readFunction applied to the downloaded file input stream.

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  25. def runNotebook(workfileId: String): Try[PythonNotebook]

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  26. def runNotebookExecution(notebook_id: String, dataSourceName: String, notebookInputs: Option[Seq[NotebookIOForExecution]], notebookOutput: Option[NotebookIOForExecution], sparkParametersMap: Option[Map[String, String]]): Try[PythonNotebookExecution]

    Runs a notebook by substituting the output path (and possibly input path(s)).

    Runs a notebook by substituting the output path (and possibly input path(s)). This will only work if the notebook attribute "ready_to_execute" is true.

    notebook_id

    Id of the notebook to retrieve

    dataSourceName

    name of the data source where inputs come from and where output will be stored

    notebookInputs

    Optional SeqNotebookIOForExecution of inputs info for substitution in the notebook

    notebookOutput

    Optional NotebookIOForExecution or single output substitution in the notebook

    sparkParametersMap

    Optional Spark parameters to be substituted in notebook if Spark is used (e.g Map("spark.executor.instances" -> "2")

    returns

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  27. def runWorkfile(workfileId: String): Try[ChorusFile]

    Runs a workfile and returns the workfile object if successful Note: this will not fail if the workfile exists but cannot be run (e.

    Runs a workfile and returns the workfile object if successful Note: this will not fail if the workfile exists but cannot be run (e.g. if the notebook server is down, the query may appear successful). Hoping to change this behavior in future releases.

    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. val workfileMap: Map[String, ChorusFileInWorkspaceMock]

  34. val workfiles: Seq[ChorusFileInWorkspaceMock]

Inherited from ChorusAPICaller

Inherited from AnyRef

Inherited from Any

Ungrouped