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 and Description
long	getActiveDeadlineSeconds() Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer +optional
int	getBackoffLimit() Specifies the number of retries before marking this job failed.
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.
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 active before the system tries to terminate it; value must be positive integer +optional
boolean	hasBackoffLimit() Specifies the number of retries before marking this job failed.
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	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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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 active
 before the system tries to terminate it; value must be positive integer
 +optional
 

optional int64 activeDeadlineSeconds = 3;

getActiveDeadlineSeconds

long getActiveDeadlineSeconds()

 Specifies the duration in seconds relative to the startTime that the job may be active
 before the system tries to terminate it; value must be positive integer
 +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.
 This field is alpha-level and is only honored by servers that enable the
 TTLAfterFinished feature.
 +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.
 This field is alpha-level and is only honored by servers that enable the
 TTLAfterFinished feature.
 +optional
 

optional int32 ttlSecondsAfterFinished = 8;