Class V1JobStatus

JobStatus represents the current state of a Job.

Inheritance
object
V1JobStatus
Implements
Inherited Members
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1JobStatus : IEquatable<V1JobStatus>

Constructors

View Source

V1JobStatus()

Declaration
public V1JobStatus()
View Source

V1JobStatus(V1JobStatus)

Declaration
protected V1JobStatus(V1JobStatus original)
Parameters
Type Name Description
V1JobStatus original

Properties

View Source

Active

The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.

Declaration
[JsonPropertyName("active")]
public int? Active { get; set; }
Property Value
Type Description
int?
View Source

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".

Declaration
[JsonPropertyName("completedIndexes")]
public string CompletedIndexes { get; set; }
Property Value
Type Description
string
View Source

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.

Declaration
[JsonPropertyName("completionTime")]
public DateTime? CompletionTime { get; set; }
Property Value
Type Description
DateTime?
View Source

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/

Declaration
[JsonPropertyName("conditions")]
public IList<V1JobCondition> Conditions { get; set; }
Property Value
Type Description
IList<V1JobCondition>
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

Failed

The number of pods which reached phase Failed. The value increases monotonically.

Declaration
[JsonPropertyName("failed")]
public int? Failed { get; set; }
Property Value
Type Description
int?
View Source

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.

Declaration
[JsonPropertyName("failedIndexes")]
public string FailedIndexes { get; set; }
Property Value
Type Description
string
View Source

Ready

The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).

Declaration
[JsonPropertyName("ready")]
public int? Ready { get; set; }
Property Value
Type Description
int?
View Source

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.

Declaration
[JsonPropertyName("startTime")]
public DateTime? StartTime { get; set; }
Property Value
Type Description
DateTime?
View Source

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.

Declaration
[JsonPropertyName("succeeded")]
public int? Succeeded { get; set; }
Property Value
Type Description
int?
View Source

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).

Declaration
[JsonPropertyName("terminating")]
public int? Terminating { get; set; }
Property Value
Type Description
int?
View Source

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.

Declaration
[JsonPropertyName("uncountedTerminatedPods")]
public V1UncountedTerminatedPods UncountedTerminatedPods { get; set; }
Property Value
Type Description
V1UncountedTerminatedPods

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
View Source

Equals(V1JobStatus?)

Declaration
public virtual bool Equals(V1JobStatus? other)
Parameters
Type Name Description
V1JobStatus other
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

View Source

operator ==(V1JobStatus?, V1JobStatus?)

Declaration
public static bool operator ==(V1JobStatus? left, V1JobStatus? right)
Parameters
Type Name Description
V1JobStatus left
V1JobStatus right
Returns
Type Description
bool
View Source

operator !=(V1JobStatus?, V1JobStatus?)

Declaration
public static bool operator !=(V1JobStatus? left, V1JobStatus? right)
Parameters
Type Name Description
V1JobStatus left
V1JobStatus right
Returns
Type Description
bool

Implements