io.kubernetes.client.proto

Interface V1Batch.JobStatusOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

V1Batch.JobStatus, V1Batch.JobStatus.Builder

Enclosing class:

V1Batch

public static interface V1Batch.JobStatusOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getActive() The number of pending and running pods.
String	getCompletedIndexes() CompletedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format.
com.google.protobuf.ByteString	getCompletedIndexesBytes() CompletedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format.
Meta.Time	getCompletionTime() Represents time when the job was completed.
Meta.TimeOrBuilder	getCompletionTimeOrBuilder() Represents time when the job was completed.
V1Batch.JobCondition	getConditions(int index) The latest available observations of an object's current state.
int	getConditionsCount() The latest available observations of an object's current state.
List<V1Batch.JobCondition>	getConditionsList() The latest available observations of an object's current state.
V1Batch.JobConditionOrBuilder	getConditionsOrBuilder(int index) The latest available observations of an object's current state.
List<? extends V1Batch.JobConditionOrBuilder>	getConditionsOrBuilderList() The latest available observations of an object's current state.
int	getFailed() The number of pods which reached phase Failed.
int	getReady() The number of pods which have a Ready condition.
Meta.Time	getStartTime() Represents time when the job controller started processing a job.
Meta.TimeOrBuilder	getStartTimeOrBuilder() Represents time when the job controller started processing a job.
int	getSucceeded() The number of pods which reached phase Succeeded.
V1Batch.UncountedTerminatedPods	getUncountedTerminatedPods() UncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
V1Batch.UncountedTerminatedPodsOrBuilder	getUncountedTerminatedPodsOrBuilder() UncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.
boolean	hasActive() The number of pending and running pods.
boolean	hasCompletedIndexes() CompletedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format.
boolean	hasCompletionTime() Represents time when the job was completed.
boolean	hasFailed() The number of pods which reached phase Failed.
boolean	hasReady() The number of pods which have a Ready condition.
boolean	hasStartTime() Represents time when the job controller started processing a job.
boolean	hasSucceeded() The number of pods which reached phase Succeeded.
boolean	hasUncountedTerminatedPods() UncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getConditionsList

List<V1Batch.JobCondition> getConditionsList()

 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.
 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
 +optional
 +patchMergeKey=type
 +patchStrategy=merge
 +listType=atomic
 

repeated .k8s.io.api.batch.v1.JobCondition conditions = 1;

getConditions

V1Batch.JobCondition getConditions(int index)

 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.
 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
 +optional
 +patchMergeKey=type
 +patchStrategy=merge
 +listType=atomic
 

repeated .k8s.io.api.batch.v1.JobCondition conditions = 1;

getConditionsCount

int getConditionsCount()

 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.
 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
 +optional
 +patchMergeKey=type
 +patchStrategy=merge
 +listType=atomic
 

repeated .k8s.io.api.batch.v1.JobCondition conditions = 1;

getConditionsOrBuilderList

List<? extends V1Batch.JobConditionOrBuilder> getConditionsOrBuilderList()

 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.
 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
 +optional
 +patchMergeKey=type
 +patchStrategy=merge
 +listType=atomic
 

repeated .k8s.io.api.batch.v1.JobCondition conditions = 1;

getConditionsOrBuilder

V1Batch.JobConditionOrBuilder getConditionsOrBuilder(int index)

 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.
 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
 +optional
 +patchMergeKey=type
 +patchStrategy=merge
 +listType=atomic
 

repeated .k8s.io.api.batch.v1.JobCondition conditions = 1;

hasStartTime

boolean hasStartTime()

 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.
 +optional
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 2;

getStartTime

Meta.Time getStartTime()

 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.
 +optional
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 2;

getStartTimeOrBuilder

Meta.TimeOrBuilder getStartTimeOrBuilder()

 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.
 +optional
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time startTime = 2;

hasCompletionTime

boolean hasCompletionTime()

 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 only set when the job finishes successfully.
 +optional
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3;

getCompletionTime

Meta.Time getCompletionTime()

 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 only set when the job finishes successfully.
 +optional
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3;

getCompletionTimeOrBuilder

Meta.TimeOrBuilder getCompletionTimeOrBuilder()

 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 only set when the job finishes successfully.
 +optional
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.Time completionTime = 3;

hasActive

boolean hasActive()

 The number of pending and running pods.
 +optional
 

optional int32 active = 4;

getActive

int getActive()

 The number of pending and running pods.
 +optional
 

optional int32 active = 4;

hasSucceeded

boolean hasSucceeded()

 The number of pods which reached phase Succeeded.
 +optional
 

optional int32 succeeded = 5;

getSucceeded

int getSucceeded()

 The number of pods which reached phase Succeeded.
 +optional
 

optional int32 succeeded = 5;

hasFailed

boolean hasFailed()

 The number of pods which reached phase Failed.
 +optional
 

optional int32 failed = 6;

getFailed

int getFailed()

 The number of pods which reached phase Failed.
 +optional
 

optional int32 failed = 6;

hasCompletedIndexes

boolean hasCompletedIndexes()

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

optional string completedIndexes = 7;

getCompletedIndexes

String getCompletedIndexes()

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

optional string completedIndexes = 7;

getCompletedIndexesBytes

com.google.protobuf.ByteString getCompletedIndexesBytes()

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

optional string completedIndexes = 7;

hasUncountedTerminatedPods

boolean hasUncountedTerminatedPods()

 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.
 This field is beta-level. The job controller only makes use of this field
 when the feature gate JobTrackingWithFinalizers is enabled (enabled
 by default).
 Old jobs might not be tracked using this field, in which case the field
 remains null.
 +optional
 

optional .k8s.io.api.batch.v1.UncountedTerminatedPods uncountedTerminatedPods = 8;

getUncountedTerminatedPods

V1Batch.UncountedTerminatedPods getUncountedTerminatedPods()

 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.
 This field is beta-level. The job controller only makes use of this field
 when the feature gate JobTrackingWithFinalizers is enabled (enabled
 by default).
 Old jobs might not be tracked using this field, in which case the field
 remains null.
 +optional
 

optional .k8s.io.api.batch.v1.UncountedTerminatedPods uncountedTerminatedPods = 8;

getUncountedTerminatedPodsOrBuilder

V1Batch.UncountedTerminatedPodsOrBuilder getUncountedTerminatedPodsOrBuilder()

 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.
 This field is beta-level. The job controller only makes use of this field
 when the feature gate JobTrackingWithFinalizers is enabled (enabled
 by default).
 Old jobs might not be tracked using this field, in which case the field
 remains null.
 +optional
 

optional .k8s.io.api.batch.v1.UncountedTerminatedPods uncountedTerminatedPods = 8;

hasReady

boolean hasReady()

 The number of pods which have a Ready condition.
 This field is alpha-level. The job controller populates the field when
 the feature gate JobReadyPods is enabled (disabled by default).
 +optional
 

optional int32 ready = 9;

getReady

int getReady()

 The number of pods which have a Ready condition.
 This field is alpha-level. The job controller populates the field when
 the feature gate JobReadyPods is enabled (disabled by default).
 +optional
 

optional int32 ready = 9;