Package io.fabric8.kubernetes.api.model.batch.v1

Class CronJobSpec

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<CronJobSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class CronJobSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<CronJobSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    CronJobSpec describes how the job execution will look like and when it will actually run.
    See Also:
    Serialized Form

    • Constructor Detail

      • CronJobSpec

        public CronJobSpec()
        No args constructor for use in serialization

    • Method Detail

      • getConcurrencyPolicy

        public String getConcurrencyPolicy()
        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

      • setConcurrencyPolicy

        public void setConcurrencyPolicy​(String 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

      • getFailedJobsHistoryLimit

        public Integer getFailedJobsHistoryLimit()
        The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.

      • setFailedJobsHistoryLimit

        public void setFailedJobsHistoryLimit​(Integer failedJobsHistoryLimit)
        The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.

      • getJobTemplate

        public JobTemplateSpec getJobTemplate()
        CronJobSpec describes how the job execution will look like and when it will actually run.

      • setJobTemplate

        public void setJobTemplate​(JobTemplateSpec jobTemplate)
        CronJobSpec describes how the job execution will look like and when it will actually run.

      • getSchedule

        public String getSchedule()
        The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

      • setSchedule

        public void setSchedule​(String schedule)
        The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.

      • getStartingDeadlineSeconds

        public Long getStartingDeadlineSeconds()
        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.

      • setStartingDeadlineSeconds

        public void setStartingDeadlineSeconds​(Long 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.

      • getSuccessfulJobsHistoryLimit

        public Integer getSuccessfulJobsHistoryLimit()
        The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

      • setSuccessfulJobsHistoryLimit

        public void setSuccessfulJobsHistoryLimit​(Integer successfulJobsHistoryLimit)
        The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.

      • getSuspend

        public Boolean getSuspend()
        This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

      • setSuspend

        public void setSuspend​(Boolean suspend)
        This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.

      • getTimeZone

        public String getTimeZone()
        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

      • setTimeZone

        public void setTimeZone​(String 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

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)