Class/Object

com.alpine.plugin.test.mock

ChorusAPICallerMock

Related Docs: object ChorusAPICallerMock | package mock

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

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 createOrUpdateChorusFile(workspaceId: String, file: File, overwrite: Boolean): Try[ChorusFile]

    Permalink
    Definition Classes
    ChorusAPICallerMockChorusAPICaller
  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 getNotebookDetails(notebookID: String): Try[NotebookDetails]

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

    Permalink

    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
  13. def getWorkfileDBDataSources(workfileID: String): Try[List[ChorusDBSourceInfo]]

    Permalink

    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
  14. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  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 readWorkfileAsText(workfile: ChorusFile): Try[String]

    Permalink

    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
  20. def readWorkfileAsText(workFileID: String): Try[String]

    Permalink

    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
  21. def readWorkfileInputStream[R](workfile: ChorusFile, readFunction: (InputStream) ⇒ R): Try[R]

    Permalink

    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
  22. def readWorkfileInputStream[R](workFileID: String, readFunction: (InputStream) ⇒ R): Try[R]

    Permalink

    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
  23. def runNotebook(workfileId: String): Try[PythonNotebook]

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

    Permalink

    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")

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

    Permalink

    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.

    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
  26. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

    Permalink
  32. val workfiles: Seq[ChorusFileInWorkspaceMock]

    Permalink

Inherited from ChorusAPICaller

Inherited from AnyRef

Inherited from Any

Ungrouped