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

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

schedule

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

jobTemplate

Specifies the job that will be created when executing a CronJob.

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.

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.

timeZone

The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones This is beta field and must be enabled via the CronJobTimeZone feature gate.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CronJobSpec
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CronJobSpec(schedule: String, jobTemplate: JobTemplateSpec, concurrencyPolicy: Option[String] = None, failedJobsHistoryLimit: Option[Int] = None, startingDeadlineSeconds: Option[Long] = None, successfulJobsHistoryLimit: Option[Int] = None, suspend: Option[Boolean] = None, timeZone: Option[String] = None)

    schedule

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

    jobTemplate

    Specifies the job that will be created when executing a CronJob.

    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.

    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.

    timeZone

    The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones This is beta field and must be enabled via the CronJobTimeZone feature gate.

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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. val concurrencyPolicy: Option[String]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val failedJobsHistoryLimit: Option[Int]
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val jobTemplate: JobTemplateSpec
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. val schedule: String
  17. val startingDeadlineSeconds: Option[Long]
  18. val successfulJobsHistoryLimit: Option[Int]
  19. val suspend: Option[Boolean]
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. val timeZone: Option[String]
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped