SchedulerWebFacade

class SchedulerWebFacade extends SchedulerFacade with ServiceWebFacadeWithDatabase with ServiceFacade[SchedulerFacade]

Linear Supertypes

ServiceWebFacadeWithDatabase, ServiceWebFacade, SchedulerFacade, ServiceFacade[SchedulerFacade], ServiceFacadeWithDatabase, ServiceFacadeBase, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SchedulerWebFacade
ServiceWebFacadeWithDatabase
ServiceWebFacade
SchedulerFacade
ServiceFacade
ServiceFacadeWithDatabase
ServiceFacadeBase
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new SchedulerWebFacade(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
SchedulerWebFacade → ServiceWebFacade
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native() @HotSpotIntrinsicCandidate()
val environment: String

Definition Classes
SchedulerWebFacade → ServiceWebFacade → ServiceFacadeBase
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def getAllJobs(states: Set[String], minDate: LocalDateTime, limit: Option[Int]): Array[JobInfo]
Gets all jobs for given job states and creation time limit.
Gets all jobs for given job states and creation time limit.
states
The set of JobStates to include.
minDate
The lower bound on the job creation time.
limit
An optional value for the maximum number of jobs to return (most recent first).

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getBatch(id: String): BatchInfo
Gets the most recent version of a specific batch.
Gets the most recent version of a specific batch.
id
The unique id of the batch.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getBatchJob(batchId: String, id: UUID): BatchJobInfo
Gets the batch job for a specific batch and job id.
Gets the batch job for a specific batch and job id.
batchId
The unique id of the batch.
id
The UUID for the batch job.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getBatchJobs(states: Set[String], minDate: LocalDateTime, limit: Option[Int]): Array[BatchJobInfo]
Gets all batch jobs for given job states and creation time limit.
Gets all batch jobs for given job states and creation time limit.
states
The set of JobStates to include.
minDate
The lower bound on the job creation time. LocalDateTime.MIN not supported. Use DateTimeSupport.minDate instead.
limit
An optional value for the maximum number of jobs to return (most recent first).

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getBatches(includeDeleted: Boolean): Array[BatchInfo]
Gets the most recent version of each batch, including deleted.
Gets the most recent version of each batch, including deleted.
includeDeleted
Whether to include deleted batches.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getBatches: Array[BatchInfo]
Gets the most recent version of each batch.
Gets the most recent version of each batch.

Definition Classes
SchedulerFacade
def getBuildInfo: BuildLabels

Definition Classes
ServiceWebFacade
def getCacheStatistics: Array[CacheStatistics]

Definition Classes
ServiceWebFacade → ServiceFacadeBase
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def getDatabase(outputStream: OutputStream): Unit

Definition Classes
ServiceWebFacadeWithDatabase
def getDatabasePath: String

Definition Classes
ServiceWebFacadeWithDatabase
def getFile(path: String, outputStream: OutputStream): Unit

Definition Classes
ServiceWebFacade → ServiceFacadeBase
def getJob(id: UUID): JobInfo
Gets the job for a specific job id.
Gets the job for a specific job id.
id
The UUID for the job.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getJobs(ids: List[UUID]): Array[JobInfo]
Gets the jobs for a specific list of job ids.
Gets the jobs for a specific list of job ids.
ids
The list of UUID for the jobs.

Definition Classes
SchedulerWebFacade → SchedulerFacade
val getJobsDefaultStates: Set[String]
The default value for states used in getAllJobs and getBatchJobs.
The default value for states used in getAllJobs and getBatchJobs. The value is JobStates.pending, JobStates.running and JobStates.submitted.

Definition Classes
SchedulerFacade
def getLogForBatchJob(id: UUID): String
Gets the log for a batch job with a specific job id.
Gets the log for a batch job with a specific job id.
id
The UUID for the batch job.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getLogForJob(id: UUID): SparkJobLog
Gets the log for a job with a specific job id.
Gets the log for a job with a specific job id.
id
The UUID for the job.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getLogForScheduleState(scheduleId: String): String
Gets the log for the state of a specific schedule.
Gets the log for the state of a specific schedule.
scheduleId
The unique id of the schedule.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getLogLevel: String

Definition Classes
ServiceWebFacade → ServiceFacadeBase
def getPerformanceMetrics: PerformanceMetrics

Definition Classes
ServiceWebFacade → ServiceFacadeBase
def getRaw(url: String): String

Definition Classes
ServiceWebFacade
def getRunners: Array[RunnerInfo]
Gets information on all registered runner services.
Gets information on all registered runner services.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getSchedule(id: String): ScheduleInfo
Gets the most recent version of a specific schedule.
Gets the most recent version of a specific schedule.
id
The unique id of the schedule.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getSchedules(includeDeleted: Boolean = false): Array[ScheduleInfo]
Gets the most recent version of each schedule, including deleted.
Gets the most recent version of each schedule, including deleted.
includeDeleted
Whether to include deleted schedules.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getSchedules: Array[ScheduleInfo]
Gets the most recent version of each schedule.
Gets the most recent version of each schedule.

Definition Classes
SchedulerFacade
def getScript(id: String): ScriptInfo
Gets the most recent version of a specific script.
Gets the most recent version of a specific script.
id
The unique id of the script.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getScripts(includeDeleted: Boolean = false): Array[ScriptInfo]
Gets the most recent version of each script, including deleted.
Gets the most recent version of each script, including deleted.
includeDeleted
Whether to include deleted scripts.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getScripts: Array[ScriptInfo]
Gets the most recent version of each script.
Gets the most recent version of each script.

Definition Classes
SchedulerFacade
def getStateForSchedule(id: String): ScheduleStateInfo
Gets the current state of a specific schedule.
Gets the current state of a specific schedule.
id
The unique id of the schedule.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getVersion: String

Definition Classes
ServiceWebFacade → ServiceFacadeBase
def getVersionForBatch(id: String, version: UUID): BatchInfo
Gets a specific version of a specific batch.
Gets a specific version of a specific batch.
id
The unique id of the batch.
version
The UUID for the version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getVersionForSchedule(id: String, version: UUID): ScheduleInfo
Gets a specific version of a specific schedule.
Gets a specific version of a specific schedule.
id
The unique id of the schedule.
version
The UUID for the version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getVersionForScript(id: String, version: UUID): ScriptInfo
Gets a specific version of a specific script.
Gets a specific version of a specific script.
id
The unique id of the script.
version
The UUID for the version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getVersionForWizard(id: String, version: UUID): WizardInfo
Gets a specific version of a specific wizard.
Gets a specific version of a specific wizard.
id
The unique id of the wizard.
version
The UUID for the version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getVersionsForBatch(id: String): Array[BatchInfo]
Gets all versions of a specific batch.
Gets all versions of a specific batch.
id
The unique id of the batch.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getVersionsForSchedule(id: String): Array[ScheduleInfo]
Gets all versions of a specific schedule.
Gets all versions of a specific schedule.
id
The unique id of the schedule.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getVersionsForScript(id: String): Array[ScriptInfo]
Gets all versions of a specific script.
Gets all versions of a specific script.
id
The unique id of the script.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getVersionsForWizard(id: String): Array[WizardInfo]
Gets all versions of a specific wizard.
Gets all versions of a specific wizard.
id
The unique id of the wizard.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getWizard(id: String): WizardInfo
Gets the most recent version of a specific wizard.
Gets the most recent version of a specific wizard.
id
The unique id of the wizard.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getWizardSession(sessionId: UUID): WizardSessionInfo
Gets the wizard session for a specific session id.
Gets the wizard session for a specific session id.
sessionId
The UUID for the session.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getWizardSessions(states: Set[String]): Array[WizardSessionInfo]
Gets the wizard sessions for given session states.
Gets the wizard sessions for given session states.
states
The set of WizardSessionStates to include.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getWizards(includeDeleted: Boolean = false): Array[WizardInfo]
Gets the most recent version of each wizard, including deleted.
Gets the most recent version of each wizard, including deleted.
includeDeleted
Whether to include deleted wizards.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def getWizards: Array[WizardInfo]
Gets the most recent version of each wizard.
Gets the most recent version of each wizard.

Definition Classes
SchedulerFacade
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
val hostAddress: String

Definition Classes
SchedulerWebFacade → ServiceWebFacade
implicit def httpChannel: HttpChannel

Definition Classes
ServiceWebFacade
val httpClient: HttpClient

Definition Classes
SchedulerWebFacade → 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
@native() @HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
def postActionForWizardSession(action: WizardAction): WizardSessionInfo
Performs a given action on a wizard session.
Performs a given action on a wizard session.
action
The wizard action to perform.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postBatch(content: BatchContent): Unit
Creates a new version of a batch with the specific content.
Creates a new version of a batch with the specific content.
content
The content of the new version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postBatch(config: String): Unit
Creates a new version of a batch with the specific content.
Creates a new version of a batch with the specific content.
config
The content of the new version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postCachePurge(id: Option[String]): Unit

Definition Classes
ServiceWebFacade → ServiceFacadeBase
def postCancelForBatchJob(id: UUID): Unit
Cancels a specific batch job.
Cancels a specific batch job. This also cancels all jobs that are part of the batch.
id
The UUID for the batch job.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postCancelForJob(id: UUID): Unit
Cancels a specific job.
Cancels a specific job.
id
The UUID for the job.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postDatabaseBackup(encryptionEnabled: Option[Boolean], encryptionMasterKeyIdentifier: Option[String], outputRepository: String): Unit

Definition Classes
ServiceWebFacadeWithDatabase
def postDeleteForBatch(id: String): Unit
Marks a specific batch as deleted.
Marks a specific batch as deleted. Technically a copy of the most recent version is created with the deletion time set.
id
The unique id of the batch.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postDeleteForSchedule(id: String): Unit
Marks a specific schedule as deleted.
Marks a specific schedule as deleted. Technically a copy of the most recent version is created with the deletion time set.
id
The unique id of the schedule.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postDeleteForScript(id: String): Unit
Marks a specific script as deleted.
Marks a specific script as deleted. Technically a copy of the most recent version is created with the deletion time set.
id
The unique id of the script.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postDeleteForWizard(id: String): Unit
Marks a specific wizard as deleted.
Marks a specific wizard as deleted. Technically a copy of the most recent version is created with the deletion time set.
id
The unique id of the wizard.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postErrorForJob(id: UUID, error: ExceptionChain): Unit
Update the error information for a specific job.
Update the error information for a specific job.
id
The UUID for the job.
error
The error information to include.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postHost(name: String, isLocal: Boolean, modes: List[String], memoryGb: Int, minMemoryLevel: Int, instanceId: Option[String]): Unit
Registers or updates information on a runner service host with a given name.
Registers or updates information on a runner service host with a given name.
name
The service name of the runner.
isLocal
Whether the runner uses spark in local mode or distributed.
modes
The RunnerModes supported by the runner.
memoryGb
The amount of memory in GB available to the runner.
minMemoryLevel
The minimum memory level for jobs to be accepted by the runner.
instanceId
The AWS EC2 instance id for the runner, if available.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postHostForJobs(host: String): Array[JobInfo]
Assign jobs ready for execution to a given runner.
Assign jobs ready for execution to a given runner. Only compatible jobs are assigned, which depends on both the properties of the job and the runner.
host
The service name of the runner.
returns
The jobs that were assigned to the runner.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postLogForJob(id: UUID, log: String): Unit
Appends content to the log for a specific job.
Appends content to the log for a specific job.
id
The UUID for the job.
log
The text content to append. A line break is inserted if the log is non-empty.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postNewWizardSession(wizardId: String): WizardSessionInfo
Creates a new session for a specific wizard.
Creates a new session for a specific wizard.
wizardId
The unique id of the wizard.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postProgressForJob(id: UUID, progress: Double): Unit
Update the progress value for a specific job.
Update the progress value for a specific job. If the current progress is 1 the value can only be set to 0.
id
The UUID for the job.
progress
A value between 0 and 1.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postRaw(url: String, body: String): String

Definition Classes
ServiceWebFacade
def postRestart: Unit

Definition Classes
ServiceWebFacade → ServiceFacadeBase
val postRunDefaultDate: () ⇒ LocalDateTime
The default value for date used in postRunForSource, postRunForPipeline and postRunForBatch.
The default value for date used in postRunForSource, postRunForPipeline and postRunForBatch. The value is a function that returns the current UTC time.

Definition Classes
SchedulerFacade
def postRunForBatch(id: String, tag: String, date: LocalDateTime, expires: Option[LocalDateTime], updates: BatchUpdates): BatchJobInfo
Creates a batch job for running a specific batch on a given date, restricted to a specific tag.
Creates a batch job for running a specific batch on a given date, restricted to a specific tag. This creates jobs for all sources and pipelines with results missing from the batch, with a requested update or with a dependency on a requested update. Untagged versions may be used if no matching tag exists.
id
The unique id of the batch.
tag
The tag to use as restriction.
date
The date and time to associate with the run.
expires
The date and time to associate with the run.
updates
A specification of source and pipelines that should be updated. This will also update dependencies in the batch.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postRunForDashboard(id: String, mode: String): JobInfo
Creates a job for updating a specific dashboard for a given mode.
Creates a job for updating a specific dashboard for a given mode.
id
The unique id of the dashboard.
mode
The RunnerModes value to use for the job. Should be RunnerModes.realtime or RunnerModes.batch.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postRunForPipeline(id: String, tag: String, date: LocalDateTime): Array[JobInfo]
Creates a job for running a specific pipeline on a given date, restricted to a specific tag.
Creates a job for running a specific pipeline on a given date, restricted to a specific tag. An untagged version may be used if no matching tag exists.
id
The unique id of the pipeline.
tag
The tag to use as restriction.
date
The date and time to associate with the run.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postRunForScript(id: String, body: String, resource: Option[String], method: String): String
Runs a specific script with given body.
Runs a specific script with given body.
id
The unique id of the script.
body
The body to supply as input to the script.
resource
An optional resource string supplied to the script.
method
The HTTP method for the call.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postRunForScript(id: String, parameters: ScriptParameters, resource: Option[String] = None): ScriptResults
Runs a specific script with given parameters.
Runs a specific script with given parameters.
id
The unique id of the script.
parameters
The parameters to supply as input to the script.
resource
An optional resource string supplied to the script.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postRunForSource(id: String, tag: String, date: LocalDateTime): JobInfo
Creates a job for running a specific source on a given date, restricted to a specific tag.
Creates a job for running a specific source on a given date, restricted to a specific tag. An untagged version may be used if no matching tag exists.
id
The unique id of the source.
tag
The tag to use as restriction.
date
The date and time to associate with the run.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postRunNextForJob(id: UUID): JobInfo
Sets a priority on the job to make sure that it will be the next one to run.
Sets a priority on the job to make sure that it will be the next one to run.
id
The UUID for the job.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postSchedule(content: ScheduleContent): Unit
Creates a new version of a schedule with the specific content.
Creates a new version of a schedule with the specific content.
content
The content of the new version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postScript(content: ScriptContent): Unit
Creates a new version of a script with the specific content.
Creates a new version of a script with the specific content.
content
The content of the new version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postStartForSchedule(id: String): Unit
Starts a specific schedule.
Starts a specific schedule. This enables the automatic scheduling of jobs.
id
The unique id of the schedule.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postStateForJob(id: UUID, state: String): Unit
Update the state for a specific job.
Update the state for a specific job. If the current job state is in JobStates.absorbing the state can only be set to JobStates.pending.
id
The UUID for the job.
state
The JobStates value to set.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postStopForSchedule(id: String, suspend: Boolean = false): Unit
Stops a specific schedule.
Stops a specific schedule. A stopped schedule will never perform any automated actions.
id
The unique id of the schedule.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postTestForScript(content: ScriptContent, body: String, resource: Option[String], method: String): String
Tests a given script definition with given body.
Tests a given script definition with given body. The only difference from postRunForScript is that the script definition is given as a parameter.
content
The definition of the script.
body
The body to supply as input to the script.
resource
An optional resource string supplied to the script.
method
The HTTP method for the call.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postTestForScript(content: ScriptContent, parameters: ScriptParameters, resource: Option[String] = None): ScriptResults
Tests a given script definition with given parameters.
Tests a given script definition with given parameters. The only difference from postRunForScript is that the script definition is given as a parameter.
content
The definition of the script.
parameters
The parameters to supply as input to the script.
resource
An optional resource string supplied to the script.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postTestForWizard(wizard: WizardContent): Unit
Tests a given wizard definition for validity.
Tests a given wizard definition for validity. Besides compilation some structural rules are checked, but the wizard is not run.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def postVacuumDatabase: Unit

Definition Classes
ServiceWebFacadeWithDatabase
def postWizard(content: WizardContent): Unit
Creates a new version of a wizard with the specific content.
Creates a new version of a wizard with the specific content.
content
The content of the new version.

Definition Classes
SchedulerWebFacade → SchedulerFacade
def setLogLevel(level: String): Unit

Definition Classes
ServiceWebFacade → ServiceFacadeBase
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
val token: UUID

Definition Classes
SchedulerWebFacade → ServiceWebFacade
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def waitIsReady(timeoutSeconds: Int, pollIntervalSeconds: Int): Unit

Definition Classes
ServiceFacadeBase
def withTimeout(seconds: Int): SchedulerWebFacade

Definition Classes
SchedulerWebFacade → ServiceWebFacade → ServiceFacade
def withToken(other: UUID): SchedulerWebFacade

Definition Classes
SchedulerWebFacade → ServiceFacade

Deprecated Value Members

def finalize(): Unit

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

Packages

SchedulerWebFacade

class SchedulerWebFacade extends SchedulerFacade with ServiceWebFacadeWithDatabase with ServiceFacade[SchedulerFacade]

Instance Constructors

Value Members

Deprecated Value Members

Inherited from ServiceWebFacadeWithDatabase

Inherited from ServiceWebFacade

Inherited from SchedulerFacade

Inherited from ServiceFacade[SchedulerFacade]

Inherited from ServiceFacadeWithDatabase

Inherited from ServiceFacadeBase

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

SchedulerWebFacade 

class SchedulerWebFacade extends SchedulerFacade with ServiceWebFacadeWithDatabase with ServiceFacade[SchedulerFacade]

Instance Constructors

Value Members

Deprecated Value Members

Inherited from ServiceWebFacadeWithDatabase

Inherited from ServiceWebFacade

Inherited from SchedulerFacade

Inherited from ServiceFacade[SchedulerFacade]

Inherited from ServiceFacadeWithDatabase

Inherited from ServiceFacadeBase

Inherited from AnyRef

Inherited from Any

Ungrouped

SchedulerWebFacade