class RunnerWebFacade extends RunnerFacade with ServiceWebFacade
- Alphabetic
- By Inheritance
- RunnerWebFacade
- ServiceWebFacade
- RunnerFacade
- ServiceFacade
- ServiceFacadeBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new RunnerWebFacade(hostAddress: String, httpClient: HttpClient, environment: String, token: UUID, connectAttempts: Int)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- var _httpChannel: HttpChannel
- Attributes
- protected
- Definition Classes
- RunnerWebFacade → ServiceWebFacade
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val environment: String
- Definition Classes
- RunnerWebFacade → ServiceWebFacade → ServiceFacadeBase
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def getBuildInfo: BuildLabels
- Definition Classes
- ServiceWebFacade
- def getCacheStatistics: Array[CacheStatistics]
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getExecutableForTransformForPipeline(pipeline: PipelineContent, transform: String): String
Builds a scala code snippet that includes the transform code of a pipeline definition and compiles as a standalone file, assuming all library dependencies are present.
Builds a scala code snippet that includes the transform code of a pipeline definition and compiles as a standalone file, assuming all library dependencies are present.
- pipeline
The pipeline definition.
- transform
The id of the transform to use.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def getFile(path: String, outputStream: OutputStream): Unit
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- def getLogLevel: String
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- val getOutputDefaultLocale: String
The default value for
localeused in the API.The default value for
localeused in the API. The value is equal to EnvironmentVariables.DATASOLVR_DEFAULT_OUTPUT_LOCALE.- Definition Classes
- RunnerFacade
- val getOutputDefaultMaxDecimals: Int
The default value for
maxDecimalsused in the API.The default value for
maxDecimalsused in the API. The value is equal to EnvironmentVariables.DATASOLVR_DEFAULT_MAX_DECIMALS.- Definition Classes
- RunnerFacade
- def getPerformanceMetrics: PerformanceMetrics
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- def getRaw(url: String): String
- Definition Classes
- ServiceWebFacade
- def getSparkUIEndpoint: String
The endpoint for contacting the API of the Apache Spark UI.
The endpoint for contacting the API of the Apache Spark UI. This is used to report progress on job execution similar to what is seen the Spark UI.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def getTestResultsOutputForTransformForPipeline(pipeline: PipelineContent, transform: String, date: LocalDateTime, sampleSize: Option[Int], outputSize: Option[Int], locale: String, maxDecimals: Int, serializeAsJson: Boolean = false): TestResultOutput
Gets the results of a test execution for given pipeline definition and transform.
Gets the results of a test execution for given pipeline definition and transform. This does not schedule a new test execution, but assumes that a completed execution matching the parameters exists.
- pipeline
The pipeline definition.
- transform
The id of the transform.
- date
The date to use for running the pipeline.
- sampleSize
An optional sample size which is applied to all imports in the pipeline.
- outputSize
An optional output size which is applied as a limit on the output data set.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- serializeAsJson
When true the result's TestResultOutput.dataTableContent contains a json string else it contains a csv string.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def getTestResultsStatusForPipeline(pipeline: PipelineContent, date: LocalDateTime, sampleSize: Option[Int], outputSize: Option[Int]): Array[TransformTestResultStatus]
Gets the status of a test execution for each transform in a given pipeline definition.
Gets the status of a test execution for each transform in a given pipeline definition.
- pipeline
The pipeline definition.
- date
The date to use for running the pipeline.
- sampleSize
An optional sample size which is applied to all imports in the pipeline.
- outputSize
An optional output size which is applied as a limit on the output data set.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def getVersion: String
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val hostAddress: String
- Definition Classes
- RunnerWebFacade → ServiceWebFacade
- implicit def httpChannel: HttpChannel
- Definition Classes
- ServiceWebFacade
- val httpClient: HttpClient
- Definition Classes
- RunnerWebFacade → ServiceWebFacade
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isReady: Boolean
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def postAnalyzeCodeForColumns(code: String, tag: String, date: LocalDateTime): Array[Column]
Get auto-complete column candidates at a given point in a SQL code snippet.
Get auto-complete column candidates at a given point in a SQL code snippet.
- code
The information on the code snippet and completion point.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postAnalyzeCodeForColumnsForPipeline(pipeline: PipelineContent, transform: String): Array[Column]
Get auto-complete column candidates at a given point in a SQL transform in a pipeline.
Get auto-complete column candidates at a given point in a SQL transform in a pipeline.
- pipeline
The pipeline definition.
- transform
The transform in the pipeline.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postAutoCompleteCode(codeRequest: AutoCompleteRequest): Array[AutoComplete]
Get auto-complete candidates at a given point in a code snippet.
Get auto-complete candidates at a given point in a code snippet.
- codeRequest
The information on the code snippet and completion point.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postAutoCompleteCodeForPipeline(pipeline: PipelineContent, transform: String, offset: Int): Array[AutoComplete]
Get auto-complete candidates at a given point in a transform in a pipeline.
Get auto-complete candidates at a given point in a transform in a pipeline.
- pipeline
The pipeline definition.
- transform
The id of the transform in the pipeline.
- offset
The character offset for which to obtain auto-complete candidates.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postCachePurge(id: Option[String]): Unit
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- def postCancelJobGroupForUser(): Unit
Cancel all running test executions started by the calling user.
Cancel all running test executions started by the calling user.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postCompileCode(codeRequest: CompileRequest): Array[Annotation]
Get compilation errors for a code snippet in the form of code annotations.
Get compilation errors for a code snippet in the form of code annotations.
- codeRequest
The information on the code snippet to compile.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postCompileCodeForPipeline(pipeline: PipelineContent, transform: String): Array[Annotation]
Get compilation errors for a transform in a pipeline definition in the form of code annotations.
Get compilation errors for a transform in a pipeline definition in the form of code annotations.
- pipeline
The pipeline definition.
- transform
The transform in the pipeline.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- val postDefaultDate: () => LocalDateTime
The default value for
dateused in the API.The default value for
dateused in the API. The value is a function that returns the current UTC time.- Definition Classes
- RunnerFacade
- val postDefaultOutputSize: Int
The default value for
outputSizeused in the API.The default value for
outputSizeused in the API. The value is 1000.- Definition Classes
- RunnerFacade
- val postDefaultSampleSize: Int
The default value for
sampleSizeused in the API.The default value for
sampleSizeused in the API. The value is 200.- Definition Classes
- RunnerFacade
- def postFormatCode(request: FormatRequest): String
Formats a code snippet.
Formats a code snippet.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postGenerateDashboardForSourceSnapshotInfo(snapshotInfo: SourceSnapshotInfo, targetColumn: String): DashboardContent
Generates a dashboard definition based on a source snapshot and a target column.
Generates a dashboard definition based on a source snapshot and a target column. This method attempts to generate a meaningful dashboard definition for a given source snapshot and primary target column of interest.
- snapshotInfo
The source snapshot to generate the dashboard from.
- targetColumn
The name of the primary column to use for deciding which charts to present.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postGenerateForSource(description: SourceDescription, options: Map[String, String], tag: String = Tags.empty): SourceContent
Generates a complete source definition based on the a source description.
Generates a complete source definition based on the a source description. This method attempts to generate a meaningful source data description by running the source from the the source description and looking at the schema and contents of the resulting data set.
- description
A description of how to run the source.
- options
A collections of options the source should be run with.
- tag
An optional tag the source should be run with.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postRaw(url: String, body: String): String
- Definition Classes
- ServiceWebFacade
- def postRestart: Unit
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- def postTestForPipeline(pipeline: PipelineContent, date: LocalDateTime, sampleSize: Option[Int], outputSize: Option[Int], transform: Option[String], locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals): Unit
Starts a test execution for a given pipeline definition and (optionally) a specific transform.
Starts a test execution for a given pipeline definition and (optionally) a specific transform.
- pipeline
The pipeline definition.
- date
The date to use for running the pipeline.
- sampleSize
An optional sample size which is applied to all imports in the pipeline.
- outputSize
An optional output size which is applied as a limit on the output data set.
- transform
The id of the transform, or
Noneto run the full pipeline.- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postTestForSource(source: SourceContent, date: LocalDateTime, sampleSize: Option[Int], outputSize: Option[Int], locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals, serializeAsJson: Boolean = false): TestResult
Starts a test execution for a given source definition.
Starts a test execution for a given source definition.
- source
The source definition.
- date
The date to use for running the source.
- sampleSize
An optional sample size which is applied to all imports in the pipeline.
- outputSize
An optional output size which is applied as a limit on the output data set.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- serializeAsJson
When true the result's TestResultOutput.dataTableContent contains a json string else it contains a csv string.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def postValidateForPlugins(plugins: PluginsContent): Unit
Check a given collection of custom functions, transforms and modules for validity.
Check a given collection of custom functions, transforms and modules for validity.
- plugins
The content to check.
- Definition Classes
- RunnerWebFacade → RunnerFacade
- def setLogLevel(level: String): Unit
- Definition Classes
- ServiceWebFacade → ServiceFacadeBase
- def sparkMetricsFacade: SparkMetricsWebFacade
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- val token: UUID
- Definition Classes
- RunnerWebFacade → ServiceWebFacade
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitIsReady(timeoutSeconds: Int, pollIntervalSeconds: Int): Unit
- Definition Classes
- ServiceFacadeBase
- def withTimeout(seconds: Int): RunnerWebFacade
- Definition Classes
- RunnerWebFacade → ServiceWebFacade → ServiceFacade
- def withToken(other: UUID): RunnerWebFacade
- Definition Classes
- RunnerWebFacade → ServiceFacade
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)