Package io.kubernetes.client.proto

Interface V1Batch.JobSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
V1Batch.JobSpec, V1Batch.JobSpec.Builder
Enclosing class:
V1Batch
public static interface V1Batch.JobSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    int
    getBackoffLimit()
    Specifies the number of retries before marking this job failed.
    String
    getCompletionMode()
    CompletionMode specifies how Pod completions are tracked.
    com.google.protobuf.ByteString
    getCompletionModeBytes()
    CompletionMode specifies how Pod completions are tracked.
    int
    getCompletions()
    Specifies the desired number of successfully finished pods the job should be run with.
    boolean
    getManualSelector()
    manualSelector controls generation of pod labels and pod selectors.
    int
    getParallelism()
    Specifies the maximum desired number of pods the job should run at any given time.
    Meta.LabelSelector
    getSelector()
    A label query over pods that should match the pod count.
    Meta.LabelSelectorOrBuilder
    getSelectorOrBuilder()
    A label query over pods that should match the pod count.
    boolean
    getSuspend()
    Suspend specifies whether the Job controller should create Pods or not.
    V1.PodTemplateSpec
    getTemplate()
    Describes the pod that will be created when executing a job.
    V1.PodTemplateSpecOrBuilder
    getTemplateOrBuilder()
    Describes the pod that will be created when executing a job.
    int
    getTtlSecondsAfterFinished()
    ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed).
    boolean
    hasActiveDeadlineSeconds()
    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.
    boolean
    hasBackoffLimit()
    Specifies the number of retries before marking this job failed.
    boolean
    hasCompletionMode()
    CompletionMode specifies how Pod completions are tracked.
    boolean
    hasCompletions()
    Specifies the desired number of successfully finished pods the job should be run with.
    boolean
    hasManualSelector()
    manualSelector controls generation of pod labels and pod selectors.
    boolean
    hasParallelism()
    Specifies the maximum desired number of pods the job should run at any given time.
    boolean
    hasSelector()
    A label query over pods that should match the pod count.
    boolean
    hasSuspend()
    Suspend specifies whether the Job controller should create Pods or not.
    boolean
    hasTemplate()
    Describes the pod that will be created when executing a job.
    boolean
    hasTtlSecondsAfterFinished()
    ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed).

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasParallelism

      boolean hasParallelism()
       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/
 +optional
      optional int32 parallelism = 1;

    • getParallelism

      int 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/
 +optional
      optional int32 parallelism = 1;

    • hasCompletions

      boolean hasCompletions()
       Specifies the desired number of successfully finished pods the
 job should be run with.  Setting to nil 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/
 +optional
      optional int32 completions = 2;

    • getCompletions

      int getCompletions()
       Specifies the desired number of successfully finished pods the
 job should be run with.  Setting to nil 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/
 +optional
      optional int32 completions = 2;

    • hasActiveDeadlineSeconds

      boolean hasActiveDeadlineSeconds()
       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.
 +optional
      optional int64 activeDeadlineSeconds = 3;

    • getActiveDeadlineSeconds

      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.
 +optional
      optional int64 activeDeadlineSeconds = 3;

    • hasBackoffLimit

      boolean hasBackoffLimit()
       Specifies the number of retries before marking this job failed.
 Defaults to 6
 +optional
      optional int32 backoffLimit = 7;

    • getBackoffLimit

      int getBackoffLimit()
       Specifies the number of retries before marking this job failed.
 Defaults to 6
 +optional
      optional int32 backoffLimit = 7;

    • hasSelector

      boolean hasSelector()
       A label query over pods that should match the pod count.
 Normally, the system sets this field for you.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 +optional
      optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;

    • getSelector

      Meta.LabelSelector getSelector()
       A label query over pods that should match the pod count.
 Normally, the system sets this field for you.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 +optional
      optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;

    • getSelectorOrBuilder

      Meta.LabelSelectorOrBuilder getSelectorOrBuilder()
       A label query over pods that should match the pod count.
 Normally, the system sets this field for you.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 +optional
      optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 4;

    • hasManualSelector

      boolean hasManualSelector()
       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
 +optional
      optional bool manualSelector = 5;

    • getManualSelector

      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
 +optional
      optional bool manualSelector = 5;

    • hasTemplate

      boolean hasTemplate()
       Describes the pod that will be created when executing a job.
 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
      optional .k8s.io.api.core.v1.PodTemplateSpec template = 6;

    • getTemplate

      V1.PodTemplateSpec getTemplate()
       Describes the pod that will be created when executing a job.
 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
      optional .k8s.io.api.core.v1.PodTemplateSpec template = 6;

    • getTemplateOrBuilder

      V1.PodTemplateSpecOrBuilder getTemplateOrBuilder()
       Describes the pod that will be created when executing a job.
 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
      optional .k8s.io.api.core.v1.PodTemplateSpec template = 6;

    • hasTtlSecondsAfterFinished

      boolean hasTtlSecondsAfterFinished()
       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.
 +optional
      optional int32 ttlSecondsAfterFinished = 8;

    • getTtlSecondsAfterFinished

      int 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.
 +optional
      optional int32 ttlSecondsAfterFinished = 8;

    • hasCompletionMode

      boolean hasCompletionMode()
       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)`.
 This field is beta-level. More completion modes can be added in the future.
 If the Job controller observes a mode that it doesn't recognize, the
 controller skips updates for the Job.
 +optional
      optional string completionMode = 9;

    • getCompletionMode

      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)`.
 This field is beta-level. More completion modes can be added in the future.
 If the Job controller observes a mode that it doesn't recognize, the
 controller skips updates for the Job.
 +optional
      optional string completionMode = 9;

    • getCompletionModeBytes

      com.google.protobuf.ByteString getCompletionModeBytes()
       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)`.
 This field is beta-level. More completion modes can be added in the future.
 If the Job controller observes a mode that it doesn't recognize, the
 controller skips updates for the Job.
 +optional
      optional string completionMode = 9;

    • hasSuspend

      boolean hasSuspend()
       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.
 This field is beta-level, gated by SuspendJob feature flag (enabled by
 default).
 +optional
      optional bool suspend = 10;

    • getSuspend

      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.
 This field is beta-level, gated by SuspendJob feature flag (enabled by
 default).
 +optional
      optional bool suspend = 10;