Class V1JobSpec
java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1JobSpec
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen")
public class V1JobSpec
extends Object
JobSpec describes how the job execution will look like.
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionactiveDeadlineSeconds
(Long activeDeadlineSeconds) Set activeDeadlineSeconds in a chainable fashion.backoffLimit
(Integer backoffLimit) Set backoffLimit in a chainable fashion.completionMode
(String completionMode) Set completionMode in a chainable fashion.completions
(Integer completions) Set completions in a chainable fashion.boolean
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.Specifies the number of retries before marking this job failed.completionMode specifies how Pod completions are tracked.Specifies the desired number of successfully finished pods the job should be run with.manualSelector controls generation of pod labels and pod selectors.Specifies the maximum desired number of pods the job should run at any given time.suspend specifies whether the Job controller should create Pods or not.ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed).int
hashCode()
manualSelector
(Boolean manualSelector) Set manualSelector in a chainable fashion.parallelism
(Integer parallelism) Set parallelism in a chainable fashion.podFailurePolicy
(V1PodFailurePolicy podFailurePolicy) Set podFailurePolicy in a chainable fashion.selector
(V1LabelSelector selector) Set selector in a chainable fashion.void
setActiveDeadlineSeconds
(Long activeDeadlineSeconds) Set the activeDeadlineSeconds property valuevoid
setBackoffLimit
(Integer backoffLimit) Set the backoffLimit property valuevoid
setCompletionMode
(String completionMode) Set the completionMode property valuevoid
setCompletions
(Integer completions) Set the completions property valuevoid
setManualSelector
(Boolean manualSelector) Set the manualSelector property valuevoid
setParallelism
(Integer parallelism) Set the parallelism property valuevoid
setPodFailurePolicy
(V1PodFailurePolicy podFailurePolicy) Set the podFailurePolicy property valuevoid
setSelector
(V1LabelSelector selector) Set the selector property valuevoid
setSuspend
(Boolean suspend) Set the suspend property valuevoid
setTemplate
(V1PodTemplateSpec template) Set the template property valuevoid
setTtlSecondsAfterFinished
(Integer ttlSecondsAfterFinished) Set the ttlSecondsAfterFinished property valueSet suspend in a chainable fashion.template
(V1PodTemplateSpec template) Set template in a chainable fashion.toString()
ttlSecondsAfterFinished
(Integer ttlSecondsAfterFinished) Set ttlSecondsAfterFinished in a chainable fashion.
-
Field Details
-
JSON_PROPERTY_ACTIVE_DEADLINE_SECONDS
- See Also:
-
JSON_PROPERTY_BACKOFF_LIMIT
- See Also:
-
JSON_PROPERTY_COMPLETION_MODE
- See Also:
-
JSON_PROPERTY_COMPLETIONS
- See Also:
-
JSON_PROPERTY_MANUAL_SELECTOR
- See Also:
-
JSON_PROPERTY_PARALLELISM
- See Also:
-
JSON_PROPERTY_POD_FAILURE_POLICY
- See Also:
-
JSON_PROPERTY_SELECTOR
- See Also:
-
JSON_PROPERTY_SUSPEND
- See Also:
-
JSON_PROPERTY_TEMPLATE
- See Also:
-
JSON_PROPERTY_TTL_SECONDS_AFTER_FINISHED
- See Also:
-
-
Constructor Details
-
V1JobSpec
-
-
Method Details
-
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:
- the activeDeadlineSeconds property value
-
setActiveDeadlineSeconds
Set the activeDeadlineSeconds property value -
activeDeadlineSeconds
Set activeDeadlineSeconds in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
getBackoffLimit
Specifies the number of retries before marking this job failed. Defaults to 6- Returns:
- the backoffLimit property value
-
setBackoffLimit
Set the backoffLimit property value -
backoffLimit
Set backoffLimit in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
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:
- the completionMode property value
-
setCompletionMode
Set the completionMode property value -
completionMode
Set completionMode in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
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:
- the completions property value
-
setCompletions
Set the completions property value -
completions
Set completions in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
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:
- the manualSelector property value
-
setManualSelector
Set the manualSelector property value -
manualSelector
Set manualSelector in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
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:
- the parallelism property value
-
setParallelism
Set the parallelism property value -
parallelism
Set parallelism in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
getPodFailurePolicy
- Returns:
- the podFailurePolicy property value
-
setPodFailurePolicy
Set the podFailurePolicy property value -
podFailurePolicy
Set podFailurePolicy in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
getSelector
- Returns:
- the selector property value
-
setSelector
Set the selector property value -
selector
Set selector in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
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:
- the suspend property value
-
setSuspend
Set the suspend property value -
suspend
Set suspend in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
getTemplate
- Returns:
- the template property value
-
setTemplate
Set the template property value -
template
Set template in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
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:
- the ttlSecondsAfterFinished property value
-
setTtlSecondsAfterFinished
Set the ttlSecondsAfterFinished property value -
ttlSecondsAfterFinished
Set ttlSecondsAfterFinished in a chainable fashion.- Returns:
- The same instance of V1JobSpec for chaining.
-
equals
-
hashCode
public int hashCode() -
toString
-