package api
- Alphabetic
- Public
- All
Type Members
-
case class
Cancel
(jobId: String) extends SchedulerRequest with Product with Serializable
A request to cancel a previously scheduled job.
A request to cancel a previously scheduled job.
- jobId
the identifier of the job to cancel
-
case class
CancelResponse
(status: JobStatus) extends SchedulerResponse with Product with Serializable
The response to a Cancel request.
The response to a Cancel request.
- status
the status of the cancelled job
-
case class
GetJobStatus
(jobId: String) extends SchedulerRequest with Product with Serializable
A request to retrieve the status of a job.
A request to retrieve the status of a job.
- jobId
the identifier of the job whose status is to be retrieved
-
sealed
trait
JobStatus
extends AnyRef
The status of a job in the Scheduler module.
-
case class
JobStatusResponse
(status: Option[JobStatus]) extends SchedulerResponse with Product with Serializable
The response to a GetJobStatus request.
The response to a GetJobStatus request.
- status
the status of the requested job
-
case class
JobsStatusResponse
(jobs: Map[String, JobStatus]) extends SchedulerResponse with Product with Serializable
The response to a GetJobsStatus request.
The response to a GetJobsStatus request.
- jobs
a map from job identifiers to their statuses
- sealed trait MissedExecutionBehavior extends AnyRef
-
class
RecurrentScript
extends AnyRef
A script to be run recurrently, reusing the return values as its inner state.
A script to be run recurrently, reusing the return values as its inner state. In order to reuse the return value in the next iteration, a JSON object with the
nextInputfield must be returned. In that case, the value that is effectively used as the return value should be present in thereturnValuefield. The value that is returned in thenextInputfield is available on the next execution of the script in theinputvariable. -
case class
Schedule
(job: SchedulerJob) extends SchedulerRequest with Product with Serializable
A request to schedule a new job.
A request to schedule a new job.
- job
the job to schedule
-
case class
ScheduleResponse
(status: JobStatus) extends SchedulerResponse with Product with Serializable
The response to a Schedule request.
The response to a Schedule request.
- status
the status of the scheduled job
-
case class
Scheduled
(job: SchedulerJob) extends JobStatus with Product with Serializable
Job status indicating a successfully scheduled job.
Job status indicating a successfully scheduled job.
- job
the scheduled job
-
trait
SchedulerClient
extends AnyRef
Interface for clients capable of interacting with the Scheduler module for scheduling new jobs and managing existing ones.
-
sealed
trait
SchedulerRequest
extends AnyRef
A request to be sent to the Scheduler module.
-
trait
SchedulerResponse
extends AnyRef
A response from the Scheduler module to a SchedulerRequest.
Value Members
- object Cancel extends Serializable
- object CancelResponse extends Serializable
-
object
Cancelled
extends JobStatus with Product with Serializable
Job status indicating a cancelled job.
- object Continue extends MissedExecutionBehavior with Product with Serializable
- object ExecuteAll extends MissedExecutionBehavior with Product with Serializable
- object GetJobStatus extends Serializable
-
object
GetJobsStatus
extends SchedulerRequest with Product with Serializable
A request to retrieve the status of all jobs.
-
object
JavaScriptUtils
Functions in this object will be accessible in the JavaScript engine used for
RecurrentScript. - object JobStatus
- object JobStatusResponse extends Serializable
- object JobsStatusResponse extends Serializable
- object MissedExecutionBehavior
-
object
RecurrentScript
Contexts for running the JavaScript scripts.
- object Schedule extends Serializable
- object ScheduleResponse extends Serializable