Skip to content

batch.v1.jobStatus

"JobStatus represents the current state of a Job."

Index

Fields

fn withActive

withActive(active)

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

fn withCompletedIndexes

withCompletedIndexes(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\"."

fn withCompletionTime

withCompletionTime(completionTime)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn withConditions

withConditions(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.\n\nA 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.\n\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/"

fn withConditionsMixin

withConditionsMixin(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.\n\nA 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.\n\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/"

Note: This function appends passed data to existing values

fn withFailed

withFailed(failed)

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

fn withFailedIndexes

withFailedIndexes(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.\n\nThis field is beta-level. It can be used when the JobBackoffLimitPerIndex feature gate is enabled (enabled by default)."

fn withReady

withReady(ready)

"The number of pods which have a Ready condition."

fn withStartTime

withStartTime(startTime)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn withSucceeded

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

fn withTerminating

withTerminating(terminating)

"The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp).\n\nThis field is beta-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (enabled by default)."

obj uncountedTerminatedPods

"UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters."

fn uncountedTerminatedPods.withFailed

withFailed(failed)

"failed holds UIDs of failed Pods."

fn uncountedTerminatedPods.withFailedMixin

withFailedMixin(failed)

"failed holds UIDs of failed Pods."

Note: This function appends passed data to existing values

fn uncountedTerminatedPods.withSucceeded

withSucceeded(succeeded)

"succeeded holds UIDs of succeeded Pods."

fn uncountedTerminatedPods.withSucceededMixin

withSucceededMixin(succeeded)

"succeeded holds UIDs of succeeded Pods."

Note: This function appends passed data to existing values