com.pulumi.kubernetes.batch.v1.kotlin.JobPatch.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

import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobSpecPatch
import com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobStatusPatch
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMetaPatch
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobSpecPatch.Companion.toKotlin as jobSpecPatchToKotlin
import com.pulumi.kubernetes.batch.v1.kotlin.outputs.JobStatusPatch.Companion.toKotlin as jobStatusPatchToKotlin
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMetaPatch.Companion.toKotlin as objectMetaPatchToKotlin

/**
 * Builder for [JobPatch].
 */
@PulumiTagMarker
public class JobPatchResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: JobPatchArgs = JobPatchArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend JobPatchArgsBuilder.() -> Unit) {
        val builder = JobPatchArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): JobPatch {
        val builtJavaResource = com.pulumi.kubernetes.batch.v1.JobPatch(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return JobPatch(builtJavaResource)
    }
}

/**
 * Patch resources are used to modify existing Kubernetes resources by using
 * Server-Side Apply updates. The name of the resource must be specified, but all other properties are optional. More than
 * one patch may be applied to the same resource, and a random FieldManager name will be used for each Patch resource.
 * Conflicts will result in an error by default, but can be forced using the "pulumi.com/patchForce" annotation. See the
 * [Server-Side Apply Docs](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/managing-resources-with-server-side-apply/) for
 * additional information about using Server-Side Apply to manage Kubernetes resources with Pulumi.
 * Job represents the configuration of a single job.
 * This resource waits until its status is ready before registering success
 * for create/update, and populating output properties from the current state of the resource.
 * The following conditions are used to determine whether the resource creation has
 * succeeded or failed:
 * 1. The Job's '.status.startTime' is set, which indicates that the Job has started running.
 * 2. The Job's '.status.conditions' has a status of type 'Complete', and a 'status' set
 *    to 'True'.
 * 3. The Job's '.status.conditions' do not have a status of type 'Failed', with a
 * 	'status' set to 'True'. If this condition is set, we should fail the Job immediately.
 * If the Job has not reached a Ready state after 10 minutes, it will
 * time out and mark the resource update as Failed. You can override the default timeout value
 * by setting the 'customTimeouts' option on the resource.
 * By default, if a resource failed to become ready in a previous update,
 * Pulumi will continue to wait for readiness on the next update. If you would prefer
 * to schedule a replacement for an unready resource on the next update, you can add the
 * "pulumi.com/replaceUnready": "true" annotation to the resource definition.
 */
public class JobPatch internal constructor(
    override val javaResource: com.pulumi.kubernetes.batch.v1.JobPatch,
) : KotlinCustomResource(javaResource, JobPatchMapper) {
    /**
     * APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
     */
    public val apiVersion: Output?
        get() = javaResource.apiVersion().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
     */
    public val kind: Output?
        get() = javaResource.kind().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
     */
    public val metadata: Output?
        get() = javaResource.metadata().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    objectMetaPatchToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
     */
    public val spec: Output?
        get() = javaResource.spec().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    jobSpecPatchToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
     */
    public val status: Output?
        get() = javaResource.status().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    jobStatusPatchToKotlin(args0)
                })
            }).orElse(null)
        })
}

public object JobPatchMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.kubernetes.batch.v1.JobPatch::class == javaResource::class

    override fun map(javaResource: Resource): JobPatch = JobPatch(
        javaResource as
            com.pulumi.kubernetes.batch.v1.JobPatch,
    )
}

/**
 * @see [JobPatch].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [JobPatch].
 */
public suspend fun jobPatch(name: String, block: suspend JobPatchResourceBuilder.() -> Unit): JobPatch {
    val builder = JobPatchResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [JobPatch].
 * @param name The _unique_ name of the resulting resource.
 */
public fun jobPatch(name: String): JobPatch {
    val builder = JobPatchResourceBuilder()
    builder.name(name)
    return builder.build()
}