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

Class JobSpec

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

    • Constructor Detail

      • JobSpec

        public JobSpec()
        No args constructor for use in serialization

    • Method Detail

      • getActiveDeadlineSeconds

        public Long getActiveDeadlineSeconds()
        Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.

      • setActiveDeadlineSeconds

        public void setActiveDeadlineSeconds​(Long activeDeadlineSeconds)
        Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again.

      • getBackoffLimit

        public Integer getBackoffLimit()
        Specifies the number of retries before marking this job failed. Defaults to 6

      • setBackoffLimit

        public void setBackoffLimit​(Integer backoffLimit)
        Specifies the number of retries before marking this job failed. Defaults to 6

      • getBackoffLimitPerIndex

        public Integer getBackoffLimitPerIndex()
        Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable.

      • setBackoffLimitPerIndex

        public void setBackoffLimitPerIndex​(Integer backoffLimitPerIndex)
        Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable.

      • getCompletionMode

        public String getCompletionMode()
        completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`.


        `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.


        `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`.


        More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.

      • setCompletionMode

        public void setCompletionMode​(String completionMode)
        completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`.


        `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other.


        `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`.


        More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job.

      • getCompletions

        public Integer getCompletions()
        Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

      • setCompletions

        public void setCompletions​(Integer completions)
        Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

      • getManagedBy

        public String getManagedBy()
        ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable.


        This field is beta-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (enabled by default).

      • setManagedBy

        public void setManagedBy​(String managedBy)
        ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string `kubernetes.io/job-controller`, but skips reconciling Jobs with a custom value for this field. The value must be a valid domain-prefixed path (e.g. acme.io/foo) - all characters before the first "/" must be a valid subdomain as defined by RFC 1123. All characters trailing the first "/" must be valid HTTP Path characters as defined by RFC 3986. The value cannot exceed 63 characters. This field is immutable.


        This field is beta-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (enabled by default).

      • getManualSelector

        public Boolean getManualSelector()
        manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

      • setManualSelector

        public void setManualSelector​(Boolean manualSelector)
        manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector

      • getMaxFailedIndexes

        public Integer getMaxFailedIndexes()
        Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5.

      • setMaxFailedIndexes

        public void setMaxFailedIndexes​(Integer maxFailedIndexes)
        Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5.

      • getParallelism

        public Integer getParallelism()
        Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

      • setParallelism

        public void setParallelism​(Integer parallelism)
        Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/

      • getPodFailurePolicy

        public PodFailurePolicy getPodFailurePolicy()
        JobSpec describes how the job execution will look like.

      • setPodFailurePolicy

        public void setPodFailurePolicy​(PodFailurePolicy podFailurePolicy)
        JobSpec describes how the job execution will look like.

      • getPodReplacementPolicy

        public String getPodReplacementPolicy()
        podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods

        when they are terminating (has a metadata.deletionTimestamp) or failed.

        - Failed means to wait until a previously created Pod is fully terminated (has phase

        Failed or Succeeded) before creating a replacement Pod.


        When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.

      • setPodReplacementPolicy

        public void setPodReplacementPolicy​(String podReplacementPolicy)
        podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods

        when they are terminating (has a metadata.deletionTimestamp) or failed.

        - Failed means to wait until a previously created Pod is fully terminated (has phase

        Failed or Succeeded) before creating a replacement Pod.


        When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an beta field. To use this, enable the JobPodReplacementPolicy feature toggle. This is on by default.

      • getSelector

        public io.fabric8.kubernetes.api.model.LabelSelector getSelector()
        JobSpec describes how the job execution will look like.

      • setSelector

        public void setSelector​(io.fabric8.kubernetes.api.model.LabelSelector selector)
        JobSpec describes how the job execution will look like.

      • getSuccessPolicy

        public SuccessPolicy getSuccessPolicy()
        JobSpec describes how the job execution will look like.

      • setSuccessPolicy

        public void setSuccessPolicy​(SuccessPolicy successPolicy)
        JobSpec describes how the job execution will look like.

      • getSuspend

        public Boolean getSuspend()
        suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.

      • setSuspend

        public void setSuspend​(Boolean suspend)
        suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false.

      • getTemplate

        public io.fabric8.kubernetes.api.model.PodTemplateSpec getTemplate()
        JobSpec describes how the job execution will look like.

      • setTemplate

        public void setTemplate​(io.fabric8.kubernetes.api.model.PodTemplateSpec template)
        JobSpec describes how the job execution will look like.

      • getTtlSecondsAfterFinished

        public Integer getTtlSecondsAfterFinished()
        ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.

      • setTtlSecondsAfterFinished

        public void setTtlSecondsAfterFinished​(Integer ttlSecondsAfterFinished)
        ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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