Packages

case class CronJobSpec(concurrencyPolicy: Optional[String] = Optional.Absent, failedJobsHistoryLimit: Optional[Int] = Optional.Absent, jobTemplate: JobTemplateSpec, schedule: String, startingDeadlineSeconds: Optional[Long] = Optional.Absent, successfulJobsHistoryLimit: Optional[Int] = Optional.Absent, suspend: Optional[Boolean] = Optional.Absent) extends Product with Serializable

CronJobSpec describes how the job execution will look like and when it will actually run.

concurrencyPolicy

Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one

failedJobsHistoryLimit

The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to \1.

schedule

The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

startingDeadlineSeconds

Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

successfulJobsHistoryLimit

The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

suspend

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CronJobSpec
  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 CronJobSpec(concurrencyPolicy: Optional[String] = Optional.Absent, failedJobsHistoryLimit: Optional[Int] = Optional.Absent, jobTemplate: JobTemplateSpec, schedule: String, startingDeadlineSeconds: Optional[Long] = Optional.Absent, successfulJobsHistoryLimit: Optional[Int] = Optional.Absent, suspend: Optional[Boolean] = Optional.Absent)

    concurrencyPolicy

    Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one

    failedJobsHistoryLimit

    The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to \1.

    schedule

    The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

    startingDeadlineSeconds

    Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

    successfulJobsHistoryLimit

    The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

    suspend

    This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

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. val concurrencyPolicy: Optional[String]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val failedJobsHistoryLimit: Optional[Int]
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def getConcurrencyPolicy: IO[K8sFailure, String]

    Specifies how to treat concurrent executions of a Job.

    Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  11. def getFailedJobsHistoryLimit: IO[K8sFailure, Int]

    The number of failed finished jobs to retain.

    The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to \1.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  12. def getJobTemplate: IO[K8sFailure, JobTemplateSpec]

    Gets jobTemplate.

    Gets jobTemplate.

    This effect always succeeds, it is safe to use the field jobTemplate directly.

  13. def getSchedule: IO[K8sFailure, String]

    The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

    The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

    This effect always succeeds, it is safe to use the field schedule directly.

  14. def getStartingDeadlineSeconds: IO[K8sFailure, Long]

    Optional deadline in seconds for starting the job if it misses scheduled time for any reason.

    Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  15. def getSuccessfulJobsHistoryLimit: IO[K8sFailure, Int]

    The number of successful finished jobs to retain.

    The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  16. def getSuspend: IO[K8sFailure, Boolean]

    This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.

    This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

    If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val jobTemplate: JobTemplateSpec
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val schedule: String
  23. val startingDeadlineSeconds: Optional[Long]
  24. val successfulJobsHistoryLimit: Optional[Int]
  25. val suspend: Optional[Boolean]
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped