Packages

trait SchedulerFacade extends ServiceFacadeWithDatabase with ServiceFacade[SchedulerFacade]

The interface for the external API of the Scheduler Service.

The Scheduler Service is responsible for the management of configuration related to execution and scheduling of sources and pipelines, as well as scripts and wizards for task automation. It handles both automated and manual job scheduling, and monitors the state of jobs until completion.

Linear Supertypes
ServiceFacade[SchedulerFacade], ServiceFacadeWithDatabase, ServiceFacadeBase, AnyRef, Any
Known Subclasses
SchedulerWebFacade, SchedulerCoreFacade
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SchedulerFacade
  2. ServiceFacade
  3. ServiceFacadeWithDatabase
  4. ServiceFacadeBase
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val environment: String
    Definition Classes
    ServiceFacadeBase
  2. abstract def getAllJobs(states: Set[String] = getJobsDefaultStates, minDate: LocalDateTime = DateTimeSupport.minDate, limit: Option[Int] = None): 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).

  3. abstract 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.

  4. abstract 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.

  5. abstract def getBatchJobs(states: Set[String] = getJobsDefaultStates, minDate: LocalDateTime = DateTimeSupport.minDate, limit: Option[Int] = None): 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).

  6. abstract def getBatches(includeDeleted: Boolean = false): 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.

  7. abstract def getCacheStatistics: Array[CacheStatistics]
    Definition Classes
    ServiceFacadeBase
  8. abstract def getDatabase(outputStream: OutputStream): Unit
    Definition Classes
    ServiceFacadeWithDatabase
  9. abstract def getDatabasePath: String
    Definition Classes
    ServiceFacadeWithDatabase
  10. abstract def getFile(path: String, outputStream: OutputStream): Unit
    Definition Classes
    ServiceFacadeBase
  11. abstract 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.

  12. abstract 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.

  13. abstract 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.

  14. abstract 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.

  15. abstract 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.

  16. abstract def getLogLevel: String
    Definition Classes
    ServiceFacadeBase
  17. abstract def getPerformanceMetrics: PerformanceMetrics
    Definition Classes
    ServiceFacadeBase
  18. abstract def getRunners: Array[RunnerInfo]

    Gets information on all registered runner services.

  19. abstract 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.

  20. abstract 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.

  21. abstract 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.

  22. abstract 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.

  23. abstract 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.

  24. abstract def getVersion: String
    Definition Classes
    ServiceFacadeBase
  25. abstract 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.

  26. abstract 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.

  27. abstract 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.

  28. abstract 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.

  29. abstract 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.

  30. abstract 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.

  31. abstract 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.

  32. abstract 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.

  33. abstract 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.

  34. abstract 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.

  35. abstract 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.

  36. abstract 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.

  37. abstract def isReady: Boolean
    Definition Classes
    ServiceFacadeBase
  38. abstract 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.

  39. abstract 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.

  40. abstract def postCachePurge(id: Option[String]): Unit
    Definition Classes
    ServiceFacadeBase
  41. abstract 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.

  42. abstract def postCancelForJob(id: UUID): Unit

    Cancels a specific job.

    Cancels a specific job.

    id

    The UUID for the job.

  43. abstract def postDatabaseBackup(encryptionEnabled: Option[Boolean], encryptionMasterKeyIdentifier: Option[String], outputRepository: String = ...): Unit
    Definition Classes
    ServiceFacadeWithDatabase
  44. abstract 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.

  45. abstract 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.

  46. abstract 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.

  47. abstract 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.

  48. abstract 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.

  49. abstract def postHost(name: String, isLocal: Boolean = true, modes: List[String] = ..., memoryGb: Int = ..., minMemoryLevel: Int = 0, instanceId: Option[String] = None): 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.

  50. abstract 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.

  51. abstract 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.

  52. abstract 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.

  53. abstract 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.

  54. abstract def postRestart: Unit
    Definition Classes
    ServiceFacadeBase
  55. abstract def postRunForBatch(id: String, tag: String, date: LocalDateTime = postRunDefaultDate(), expires: Option[LocalDateTime] = None, updates: BatchUpdates = BatchUpdates(List(), List())): 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.

  56. abstract def postRunForDashboard(id: String, mode: String = RunnerModes.batch): 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.

  57. abstract def postRunForPipeline(id: String, tag: String, date: LocalDateTime = postRunDefaultDate()): 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.

  58. abstract 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.

  59. abstract 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.

  60. abstract def postRunForSource(id: String, tag: String, date: LocalDateTime = postRunDefaultDate()): 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.

  61. abstract 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.

  62. abstract 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.

  63. abstract 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.

  64. abstract 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.

  65. abstract 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.

  66. abstract 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.

  67. abstract 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.

  68. abstract 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.

  69. abstract def postTestForWizard(content: 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.

    content

    The definition of the wizard.

  70. abstract def postVacuumDatabase: Unit
    Definition Classes
    ServiceFacadeWithDatabase
  71. abstract 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.

  72. abstract def setLogLevel(level: String): Unit
    Definition Classes
    ServiceFacadeBase
  73. abstract def withTimeout(seconds: Int): SchedulerFacade
    Definition Classes
    ServiceFacade
  74. abstract def withToken(token: UUID): SchedulerFacade
    Definition Classes
    ServiceFacade
  75. abstract 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.

    Annotations
    @deprecated
    Deprecated

    use typesafe version

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def getBatches: Array[BatchInfo]

    Gets the most recent version of each batch.

  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. 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.

  11. def getSchedules: Array[ScheduleInfo]

    Gets the most recent version of each schedule.

  12. def getScripts: Array[ScriptInfo]

    Gets the most recent version of each script.

  13. def getWizards: Array[WizardInfo]

    Gets the most recent version of each wizard.

  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. 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.

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def waitIsReady(timeoutSeconds: Int, pollIntervalSeconds: Int): Unit
    Definition Classes
    ServiceFacadeBase

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from ServiceFacade[SchedulerFacade]

Inherited from ServiceFacadeWithDatabase

Inherited from ServiceFacadeBase

Inherited from AnyRef

Inherited from Any

Ungrouped