Package io.kubernetes.client.openapi.models

Class V1JobSpec

java.lang.Object
io.kubernetes.client.openapi.models.V1JobSpec
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-04-23T13:45:09.091597Z[Etc/UTC]") public class V1JobSpec extends Object
JobSpec describes how the job execution will look like.

  • Field Details

  • Constructor Details

    • V1JobSpec

      public V1JobSpec()

  • Method Details

    • activeDeadlineSeconds

      public V1JobSpec activeDeadlineSeconds(Long activeDeadlineSeconds)

    • getActiveDeadlineSeconds

      @Nullable 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.
      Returns:
      activeDeadlineSeconds

    • setActiveDeadlineSeconds

      public void setActiveDeadlineSeconds(Long activeDeadlineSeconds)

    • backoffLimit

      public V1JobSpec backoffLimit(Integer backoffLimit)

    • getBackoffLimit

      @Nullable public Integer getBackoffLimit()
      Specifies the number of retries before marking this job failed. Defaults to 6
      Returns:
      backoffLimit

    • setBackoffLimit

      public void setBackoffLimit(Integer backoffLimit)

    • backoffLimitPerIndex

      public V1JobSpec backoffLimitPerIndex(Integer backoffLimitPerIndex)

    • getBackoffLimitPerIndex

      @Nullable 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. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
      Returns:
      backoffLimitPerIndex

    • setBackoffLimitPerIndex

      public void setBackoffLimitPerIndex(Integer backoffLimitPerIndex)

    • completionMode

      public V1JobSpec completionMode(String completionMode)

    • getCompletionMode

      @Nullable 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.
      Returns:
      completionMode

    • setCompletionMode

      public void setCompletionMode(String completionMode)

    • completions

      public V1JobSpec completions(Integer completions)

    • getCompletions

      @Nullable 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/
      Returns:
      completions

    • setCompletions

      public void setCompletions(Integer completions)

    • managedBy

      public V1JobSpec managedBy(String managedBy)

    • getManagedBy

      @Nullable 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 64 characters. This field is alpha-level. The job controller accepts setting the field when the feature gate JobManagedBy is enabled (disabled by default).
      Returns:
      managedBy

    • setManagedBy

      public void setManagedBy(String managedBy)

    • manualSelector

      public V1JobSpec manualSelector(Boolean manualSelector)

    • getManualSelector

      @Nullable 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
      Returns:
      manualSelector

    • setManualSelector

      public void setManualSelector(Boolean manualSelector)

    • maxFailedIndexes

      public V1JobSpec maxFailedIndexes(Integer maxFailedIndexes)

    • getMaxFailedIndexes

      @Nullable 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. This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
      Returns:
      maxFailedIndexes

    • setMaxFailedIndexes

      public void setMaxFailedIndexes(Integer maxFailedIndexes)

    • parallelism

      public V1JobSpec parallelism(Integer parallelism)

    • getParallelism

      @Nullable 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/
      Returns:
      parallelism

    • setParallelism

      public void setParallelism(Integer parallelism)

    • podFailurePolicy

      public V1JobSpec podFailurePolicy(V1PodFailurePolicy podFailurePolicy)

    • getPodFailurePolicy

      @Nullable public V1PodFailurePolicy getPodFailurePolicy()
      Get podFailurePolicy
      Returns:
      podFailurePolicy

    • setPodFailurePolicy

      public void setPodFailurePolicy(V1PodFailurePolicy podFailurePolicy)

    • podReplacementPolicy

      public V1JobSpec podReplacementPolicy(String podReplacementPolicy)

    • getPodReplacementPolicy

      @Nullable 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.
      Returns:
      podReplacementPolicy

    • setPodReplacementPolicy

      public void setPodReplacementPolicy(String podReplacementPolicy)

    • selector

      public V1JobSpec selector(V1LabelSelector selector)

    • getSelector

      @Nullable public V1LabelSelector getSelector()
      Get selector
      Returns:
      selector

    • setSelector

      public void setSelector(V1LabelSelector selector)

    • successPolicy

      public V1JobSpec successPolicy(V1SuccessPolicy successPolicy)

    • getSuccessPolicy

      @Nullable public V1SuccessPolicy getSuccessPolicy()
      Get successPolicy
      Returns:
      successPolicy

    • setSuccessPolicy

      public void setSuccessPolicy(V1SuccessPolicy successPolicy)

    • suspend

      public V1JobSpec suspend(Boolean suspend)

    • getSuspend

      @Nullable 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.
      Returns:
      suspend

    • setSuspend

      public void setSuspend(Boolean suspend)

    • template

      public V1JobSpec template(V1PodTemplateSpec template)

    • getTemplate

      @Nonnull public V1PodTemplateSpec getTemplate()
      Get template
      Returns:
      template

    • setTemplate

      public void setTemplate(V1PodTemplateSpec template)

    • ttlSecondsAfterFinished

      public V1JobSpec ttlSecondsAfterFinished(Integer ttlSecondsAfterFinished)

    • getTtlSecondsAfterFinished

      @Nullable 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.
      Returns:
      ttlSecondsAfterFinished

    • setTtlSecondsAfterFinished

      public void setTtlSecondsAfterFinished(Integer ttlSecondsAfterFinished)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonObject

      public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOException
      Validates the JSON Object and throws an exception if issues found
      Parameters:
      jsonObj - JSON Object
      Throws:
      IOException - if the JSON Object is invalid with respect to V1JobSpec

    • fromJson

      public static V1JobSpec fromJson(String jsonString) throws IOException
      Create an instance of V1JobSpec given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of V1JobSpec
      Throws:
      IOException - if the JSON string is invalid with respect to V1JobSpec

    • toJson

      public String toJson()
      Convert an instance of V1JobSpec to an JSON string
      Returns:
      JSON string