com.pulumi.kubernetes.batch.v1.inputs.JobStatusArgs Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.kubernetes.batch.v1.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.kubernetes.batch.v1.inputs.JobConditionArgs;
import com.pulumi.kubernetes.batch.v1.inputs.UncountedTerminatedPodsArgs;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* JobStatus represents the current state of a Job.
*
*/
public final class JobStatusArgs extends com.pulumi.resources.ResourceArgs {
public static final JobStatusArgs Empty = new JobStatusArgs();
/**
* The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.
*
*/
@Import(name="active")
private @Nullable Output active;
/**
* @return The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.
*
*/
public Optional> active() {
return Optional.ofNullable(this.active);
}
/**
* completedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".
*
*/
@Import(name="completedIndexes")
private @Nullable Output completedIndexes;
/**
* @return completedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".
*
*/
public Optional> completedIndexes() {
return Optional.ofNullable(this.completedIndexes);
}
/**
* Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is set when the job finishes successfully, and only then. The value cannot be updated or removed. The value indicates the same or later point in time as the startTime field.
*
*/
@Import(name="completionTime")
private @Nullable Output completionTime;
/**
* @return Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is set when the job finishes successfully, and only then. The value cannot be updated or removed. The value indicates the same or later point in time as the startTime field.
*
*/
public Optional> completionTime() {
return Optional.ofNullable(this.completionTime);
}
/**
* The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true.
*
* A job is considered finished when it is in a terminal condition, either "Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions. Additionally, it cannot be in the "Complete" and "FailureTarget" conditions. The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled.
*
* More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
*
*/
@Import(name="conditions")
private @Nullable Output> conditions;
/**
* @return The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true.
*
* A job is considered finished when it is in a terminal condition, either "Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions. Additionally, it cannot be in the "Complete" and "FailureTarget" conditions. The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled.
*
* More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
*
*/
public Optional>> conditions() {
return Optional.ofNullable(this.conditions);
}
/**
* The number of pods which reached phase Failed. The value increases monotonically.
*
*/
@Import(name="failed")
private @Nullable Output failed;
/**
* @return The number of pods which reached phase Failed. The value increases monotonically.
*
*/
public Optional> failed() {
return Optional.ofNullable(this.failed);
}
/**
* FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". The set of failed indexes cannot overlap with the set of completed indexes.
*
* This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
*
*/
@Import(name="failedIndexes")
private @Nullable Output failedIndexes;
/**
* @return FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". The set of failed indexes cannot overlap with the set of completed indexes.
*
* This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
*
*/
public Optional> failedIndexes() {
return Optional.ofNullable(this.failedIndexes);
}
/**
* The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).
*
*/
@Import(name="ready")
private @Nullable Output ready;
/**
* @return The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).
*
*/
public Optional> ready() {
return Optional.ofNullable(this.ready);
}
/**
* Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.
*
* Once set, the field can only be removed when the job is suspended. The field cannot be modified while the job is unsuspended or finished.
*
*/
@Import(name="startTime")
private @Nullable Output startTime;
/**
* @return Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.
*
* Once set, the field can only be removed when the job is suspended. The field cannot be modified while the job is unsuspended or finished.
*
*/
public Optional> startTime() {
return Optional.ofNullable(this.startTime);
}
/**
* The number of pods which reached phase Succeeded. The value increases monotonically for a given spec. However, it may decrease in reaction to scale down of elastic indexed jobs.
*
*/
@Import(name="succeeded")
private @Nullable Output succeeded;
/**
* @return The number of pods which reached phase Succeeded. The value increases monotonically for a given spec. However, it may decrease in reaction to scale down of elastic indexed jobs.
*
*/
public Optional> succeeded() {
return Optional.ofNullable(this.succeeded);
}
/**
* The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).
*
* This field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).
*
*/
@Import(name="terminating")
private @Nullable Output terminating;
/**
* @return The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).
*
* This field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).
*
*/
public Optional> terminating() {
return Optional.ofNullable(this.terminating);
}
/**
* uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
*
* The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status:
*
* 1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding
* counter.
*
* Old jobs might not be tracked using this field, in which case the field remains null. The structure is empty for finished jobs.
*
*/
@Import(name="uncountedTerminatedPods")
private @Nullable Output uncountedTerminatedPods;
/**
* @return uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
*
* The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status:
*
* 1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding
* counter.
*
* Old jobs might not be tracked using this field, in which case the field remains null. The structure is empty for finished jobs.
*
*/
public Optional> uncountedTerminatedPods() {
return Optional.ofNullable(this.uncountedTerminatedPods);
}
private JobStatusArgs() {}
private JobStatusArgs(JobStatusArgs $) {
this.active = $.active;
this.completedIndexes = $.completedIndexes;
this.completionTime = $.completionTime;
this.conditions = $.conditions;
this.failed = $.failed;
this.failedIndexes = $.failedIndexes;
this.ready = $.ready;
this.startTime = $.startTime;
this.succeeded = $.succeeded;
this.terminating = $.terminating;
this.uncountedTerminatedPods = $.uncountedTerminatedPods;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(JobStatusArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private JobStatusArgs $;
public Builder() {
$ = new JobStatusArgs();
}
public Builder(JobStatusArgs defaults) {
$ = new JobStatusArgs(Objects.requireNonNull(defaults));
}
/**
* @param active The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.
*
* @return builder
*
*/
public Builder active(@Nullable Output active) {
$.active = active;
return this;
}
/**
* @param active The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.
*
* @return builder
*
*/
public Builder active(Integer active) {
return active(Output.of(active));
}
/**
* @param completedIndexes completedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".
*
* @return builder
*
*/
public Builder completedIndexes(@Nullable Output completedIndexes) {
$.completedIndexes = completedIndexes;
return this;
}
/**
* @param completedIndexes completedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7".
*
* @return builder
*
*/
public Builder completedIndexes(String completedIndexes) {
return completedIndexes(Output.of(completedIndexes));
}
/**
* @param completionTime Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is set when the job finishes successfully, and only then. The value cannot be updated or removed. The value indicates the same or later point in time as the startTime field.
*
* @return builder
*
*/
public Builder completionTime(@Nullable Output completionTime) {
$.completionTime = completionTime;
return this;
}
/**
* @param completionTime Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is set when the job finishes successfully, and only then. The value cannot be updated or removed. The value indicates the same or later point in time as the startTime field.
*
* @return builder
*
*/
public Builder completionTime(String completionTime) {
return completionTime(Output.of(completionTime));
}
/**
* @param conditions The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true.
*
* A job is considered finished when it is in a terminal condition, either "Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions. Additionally, it cannot be in the "Complete" and "FailureTarget" conditions. The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled.
*
* More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
*
* @return builder
*
*/
public Builder conditions(@Nullable Output> conditions) {
$.conditions = conditions;
return this;
}
/**
* @param conditions The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true.
*
* A job is considered finished when it is in a terminal condition, either "Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions. Additionally, it cannot be in the "Complete" and "FailureTarget" conditions. The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled.
*
* More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
*
* @return builder
*
*/
public Builder conditions(List conditions) {
return conditions(Output.of(conditions));
}
/**
* @param conditions The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true.
*
* A job is considered finished when it is in a terminal condition, either "Complete" or "Failed". A Job cannot have both the "Complete" and "Failed" conditions. Additionally, it cannot be in the "Complete" and "FailureTarget" conditions. The "Complete", "Failed" and "FailureTarget" conditions cannot be disabled.
*
* More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
*
* @return builder
*
*/
public Builder conditions(JobConditionArgs... conditions) {
return conditions(List.of(conditions));
}
/**
* @param failed The number of pods which reached phase Failed. The value increases monotonically.
*
* @return builder
*
*/
public Builder failed(@Nullable Output failed) {
$.failed = failed;
return this;
}
/**
* @param failed The number of pods which reached phase Failed. The value increases monotonically.
*
* @return builder
*
*/
public Builder failed(Integer failed) {
return failed(Output.of(failed));
}
/**
* @param failedIndexes FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". The set of failed indexes cannot overlap with the set of completed indexes.
*
* This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
*
* @return builder
*
*/
public Builder failedIndexes(@Nullable Output failedIndexes) {
$.failedIndexes = failedIndexes;
return this;
}
/**
* @param failedIndexes FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". The set of failed indexes cannot overlap with the set of completed indexes.
*
* This field is beta-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (enabled by default).
*
* @return builder
*
*/
public Builder failedIndexes(String failedIndexes) {
return failedIndexes(Output.of(failedIndexes));
}
/**
* @param ready The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).
*
* @return builder
*
*/
public Builder ready(@Nullable Output ready) {
$.ready = ready;
return this;
}
/**
* @param ready The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).
*
* @return builder
*
*/
public Builder ready(Integer ready) {
return ready(Output.of(ready));
}
/**
* @param startTime Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.
*
* Once set, the field can only be removed when the job is suspended. The field cannot be modified while the job is unsuspended or finished.
*
* @return builder
*
*/
public Builder startTime(@Nullable Output startTime) {
$.startTime = startTime;
return this;
}
/**
* @param startTime Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC.
*
* Once set, the field can only be removed when the job is suspended. The field cannot be modified while the job is unsuspended or finished.
*
* @return builder
*
*/
public Builder startTime(String startTime) {
return startTime(Output.of(startTime));
}
/**
* @param succeeded The number of pods which reached phase Succeeded. The value increases monotonically for a given spec. However, it may decrease in reaction to scale down of elastic indexed jobs.
*
* @return builder
*
*/
public Builder succeeded(@Nullable Output succeeded) {
$.succeeded = succeeded;
return this;
}
/**
* @param succeeded The number of pods which reached phase Succeeded. The value increases monotonically for a given spec. However, it may decrease in reaction to scale down of elastic indexed jobs.
*
* @return builder
*
*/
public Builder succeeded(Integer succeeded) {
return succeeded(Output.of(succeeded));
}
/**
* @param terminating The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).
*
* This field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).
*
* @return builder
*
*/
public Builder terminating(@Nullable Output terminating) {
$.terminating = terminating;
return this;
}
/**
* @param terminating The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).
*
* This field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default).
*
* @return builder
*
*/
public Builder terminating(Integer terminating) {
return terminating(Output.of(terminating));
}
/**
* @param uncountedTerminatedPods uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
*
* The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status:
*
* 1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding
* counter.
*
* Old jobs might not be tracked using this field, in which case the field remains null. The structure is empty for finished jobs.
*
* @return builder
*
*/
public Builder uncountedTerminatedPods(@Nullable Output uncountedTerminatedPods) {
$.uncountedTerminatedPods = uncountedTerminatedPods;
return this;
}
/**
* @param uncountedTerminatedPods uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
*
* The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status:
*
* 1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding
* counter.
*
* Old jobs might not be tracked using this field, in which case the field remains null. The structure is empty for finished jobs.
*
* @return builder
*
*/
public Builder uncountedTerminatedPods(UncountedTerminatedPodsArgs uncountedTerminatedPods) {
return uncountedTerminatedPods(Output.of(uncountedTerminatedPods));
}
public JobStatusArgs build() {
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy