package api

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. 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

  2. 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

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

  4. sealed trait JobStatus extends AnyRef

    The status of a job in the Scheduler module.

  5. 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

  6. 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

  7. sealed trait MissedExecutionBehavior extends AnyRef
  8. 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 nextInput field must be returned. In that case, the value that is effectively used as the return value should be present in the returnValue field. The value that is returned in the nextInput field is available on the next execution of the script in the input variable.

  9. 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

  10. 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

  11. 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

  12. trait SchedulerClient extends AnyRef

    Interface for clients capable of interacting with the Scheduler module for scheduling new jobs and managing existing ones.

  13. sealed trait SchedulerRequest extends AnyRef

    A request to be sent to the Scheduler module.

  14. trait SchedulerResponse extends AnyRef

    A response from the Scheduler module to a SchedulerRequest.

Value Members

  1. object Cancel extends Serializable
  2. object CancelResponse extends Serializable
  3. object Cancelled extends JobStatus with Product with Serializable

    Job status indicating a cancelled job.

  4. object Continue extends MissedExecutionBehavior with Product with Serializable
  5. object ExecuteAll extends MissedExecutionBehavior with Product with Serializable
  6. object GetJobStatus extends Serializable
  7. object GetJobsStatus extends SchedulerRequest with Product with Serializable

    A request to retrieve the status of all jobs.

  8. object JavaScriptUtils

    Functions in this object will be accessible in the JavaScript engine used for RecurrentScript.

  9. object JobStatus
  10. object JobStatusResponse extends Serializable
  11. object JobsStatusResponse extends Serializable
  12. object MissedExecutionBehavior
  13. object RecurrentScript

    Contexts for running the JavaScript scripts.

  14. object Schedule extends Serializable
  15. object ScheduleResponse extends Serializable

Ungrouped