java.lang.Object
- com.marcnuri.yakc.model.io.k8s.api.batch.v1.JobSpec

All Implemented Interfaces:

com.marcnuri.yakc.model.Model
```
public class JobSpec
extends java.lang.Object
implements com.marcnuri.yakc.model.Model
```
JobSpec describes how the job execution will look like.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class JobSpec.Builder

Constructor Summary

Constructors
Constructor	Description
`JobSpec()`
`JobSpec(java.lang.Number activeDeadlineSeconds, java.lang.Number backoffLimit, java.lang.String completionMode, java.lang.Number completions, java.lang.Boolean manualSelector, java.lang.Number parallelism, LabelSelector selector, java.lang.Boolean suspend, @NonNull PodTemplateSpec template, java.lang.Number ttlSecondsAfterFinished)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JobSpec.Builder`	`builder()`
`protected boolean`	`canEqual(java.lang.Object other)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Number`	`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.
`java.lang.Number`	`getBackoffLimit()`	Specifies the number of retries before marking this job failed.
`java.lang.String`	`getCompletionMode()`	CompletionMode specifies how Pod completions are tracked.
`java.lang.Number`	`getCompletions()`	Specifies the desired number of successfully finished pods the job should be run with.
`java.lang.Boolean`	`getManualSelector()`	manualSelector controls generation of pod labels and pod selectors.
`java.lang.Number`	`getParallelism()`	Specifies the maximum desired number of pods the job should run at any given time.
`LabelSelector`	`getSelector()`
`java.lang.Boolean`	`getSuspend()`	Suspend specifies whether the Job controller should create Pods or not.
`@NonNull PodTemplateSpec`	`getTemplate()`
`java.lang.Number`	`getTtlSecondsAfterFinished()`	ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed).
`int`	`hashCode()`
`void`	`setActiveDeadlineSeconds(java.lang.Number 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.
`void`	`setBackoffLimit(java.lang.Number backoffLimit)`	Specifies the number of retries before marking this job failed.
`void`	`setCompletionMode(java.lang.String completionMode)`	CompletionMode specifies how Pod completions are tracked.
`void`	`setCompletions(java.lang.Number completions)`	Specifies the desired number of successfully finished pods the job should be run with.
`void`	`setManualSelector(java.lang.Boolean manualSelector)`	manualSelector controls generation of pod labels and pod selectors.
`void`	`setParallelism(java.lang.Number parallelism)`	Specifies the maximum desired number of pods the job should run at any given time.
`void`	`setSelector(LabelSelector selector)`
`void`	`setSuspend(java.lang.Boolean suspend)`	Suspend specifies whether the Job controller should create Pods or not.
`void`	`setTemplate(@NonNull PodTemplateSpec template)`
`void`	`setTtlSecondsAfterFinished(java.lang.Number ttlSecondsAfterFinished)`	ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed).
`JobSpec.Builder`	`toBuilder()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JobSpec
```
public JobSpec(java.lang.Number activeDeadlineSeconds,
               java.lang.Number backoffLimit,
               java.lang.String completionMode,
               java.lang.Number completions,
               java.lang.Boolean manualSelector,
               java.lang.Number parallelism,
               LabelSelector selector,
               java.lang.Boolean suspend,
               @NonNull
               @NonNull PodTemplateSpec template,
               java.lang.Number ttlSecondsAfterFinished)
```
  - JobSpec
```
public JobSpec()
```
- Method Detail
  - builder
```
public static JobSpec.Builder builder()
```
  - toBuilder
```
public JobSpec.Builder toBuilder()
```
  - getActiveDeadlineSeconds
```
public java.lang.Number 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.
  - getBackoffLimit
```
public java.lang.Number getBackoffLimit()
```
    Specifies the number of retries before marking this job failed. Defaults to 6
  - getCompletionMode
```
public java.lang.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.
  - getCompletions
```
public java.lang.Number 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/
  - getManualSelector
```
public java.lang.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
  - getParallelism
```
public java.lang.Number 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/
  - getSelector
```
public LabelSelector getSelector()
```
  - getSuspend
```
public java.lang.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).
  - getTemplate
```
@NonNull
public @NonNull PodTemplateSpec getTemplate()
```
  - getTtlSecondsAfterFinished
```
public java.lang.Number 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.
  - setActiveDeadlineSeconds
```
public void setActiveDeadlineSeconds(java.lang.Number 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.
  - setBackoffLimit
```
public void setBackoffLimit(java.lang.Number backoffLimit)
```
    Specifies the number of retries before marking this job failed. Defaults to 6
  - setCompletionMode
```
public void setCompletionMode(java.lang.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)`.
    
    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.
  - setCompletions
```
public void setCompletions(java.lang.Number completions)
```
    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/
  - setManualSelector
```
public void setManualSelector(java.lang.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
  - setParallelism
```
public void setParallelism(java.lang.Number 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/
  - setSelector
```
public void setSelector(LabelSelector selector)
```
  - setSuspend
```
public void setSuspend(java.lang.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.
    
    This field is beta-level, gated by SuspendJob feature flag (enabled by default).
  - setTemplate
```
public void setTemplate(@NonNull
                        @NonNull PodTemplateSpec template)
```
  - setTtlSecondsAfterFinished
```
public void setTtlSecondsAfterFinished(java.lang.Number 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. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class JobSpec

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobSpec

JobSpec

Method Detail

builder

toBuilder

getActiveDeadlineSeconds

getBackoffLimit

getCompletionMode

getCompletions

getManualSelector

getParallelism

getSelector

getSuspend

getTemplate

getTtlSecondsAfterFinished

setActiveDeadlineSeconds

setBackoffLimit

setCompletionMode

setCompletions

setManualSelector

setParallelism

setSelector

setSuspend

setTemplate

setTtlSecondsAfterFinished

equals

canEqual

hashCode

toString