com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobStatus.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-kubernetes-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.kubernetes.batch.v1.kotlin.outputs

import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 * JobStatus represents the current state of a Job.
 * @property active The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.
 * @property 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".
 * @property 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.
 * @property 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/
 * @property failed The number of pods which reached phase Failed. The value increases monotonically.
 * @property 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).
 * @property ready The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).
 * @property 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.
 * @property 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.
 * @property 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).
 * @property 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.
 */
public data class JobStatus(
    public val active: Int? = null,
    public val completedIndexes: String? = null,
    public val completionTime: String? = null,
    public val conditions: List? = null,
    public val failed: Int? = null,
    public val failedIndexes: String? = null,
    public val ready: Int? = null,
    public val startTime: String? = null,
    public val succeeded: Int? = null,
    public val terminating: Int? = null,
    public val uncountedTerminatedPods: UncountedTerminatedPods? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.kubernetes.batch.v1.outputs.JobStatus): JobStatus =
            JobStatus(
                active = javaType.active().map({ args0 -> args0 }).orElse(null),
                completedIndexes = javaType.completedIndexes().map({ args0 -> args0 }).orElse(null),
                completionTime = javaType.completionTime().map({ args0 -> args0 }).orElse(null),
                conditions = javaType.conditions().map({ args0 ->
                    args0.let({ args0 ->
                        com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobCondition.Companion.toKotlin(args0)
                    })
                }),
                failed = javaType.failed().map({ args0 -> args0 }).orElse(null),
                failedIndexes = javaType.failedIndexes().map({ args0 -> args0 }).orElse(null),
                ready = javaType.ready().map({ args0 -> args0 }).orElse(null),
                startTime = javaType.startTime().map({ args0 -> args0 }).orElse(null),
                succeeded = javaType.succeeded().map({ args0 -> args0 }).orElse(null),
                terminating = javaType.terminating().map({ args0 -> args0 }).orElse(null),
                uncountedTerminatedPods = javaType.uncountedTerminatedPods().map({ args0 ->
                    args0.let({ args0 ->
                        com.pulumi.kubernetes.batch.v1.kotlin.outputs.UncountedTerminatedPods.Companion.toKotlin(args0)
                    })
                }).orElse(null),
            )
    }
}