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
CronJobTimeZonefeature gate.
- Alphabetic
- By Inheritance
- CronJobSpec
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
CronJobTimeZonefeature gate.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val concurrencyPolicy: Option[String]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val failedJobsHistoryLimit: Option[Int]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val jobTemplate: JobTemplateSpec
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val schedule: String
- val startingDeadlineSeconds: Option[Long]
- val successfulJobsHistoryLimit: Option[Int]
- val suspend: Option[Boolean]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeZone: Option[String]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated