Packages

case class Job[S <: Scheduling](id: String, scheduling: S, name: String = "", description: String = "", tags: Set[Tag] = Set.empty[Tag])(effect: SideEffect[S]) extends Product with Serializable

The job SideEffect is the most important part as it represents the real job logic to execute. A job is defined for a given Scheduling, for example it can be a TimeSeries job. Jobs are also Workflow with a single vertice.

S

The kind of Scheduling used by this job.

id

The internal job id. It will be sued to track the job state in the database, so it must not change over time otherwise the job will be seen as a new one by the scheduler. That id, being technical, should only use valid characters such as [a-zA-Z0-9_-.]

scheduling

The scheduling configuration for the job. For example a TimeSeries job can be configured to be hourly or daily, etc.

name

The job name as displayed in the UI.

description

The job description as displayed in the UI.

tags

The job tags used to filter jobs in the UI.

effect

The job side effect, representing the real job execution.

Source
Jobs.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Job
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Job(id: String, scheduling: S, name: String = "", description: String = "", tags: Set[Tag] = Set.empty[Tag])(effect: SideEffect[S])

    id

    The internal job id. It will be sued to track the job state in the database, so it must not change over time otherwise the job will be seen as a new one by the scheduler. That id, being technical, should only use valid characters such as [a-zA-Z0-9_-.]

    scheduling

    The scheduling configuration for the job. For example a TimeSeries job can be configured to be hourly or daily, etc.

    name

    The job name as displayed in the UI.

    description

    The job description as displayed in the UI.

    tags

    The job tags used to filter jobs in the UI.

    effect

    The job side effect, representing the real job execution.

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val description: String
  7. val effect: SideEffect[S]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. val id: String
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val name: String
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  17. val scheduling: S
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. val tags: Set[Tag]
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped