com.pulumi.kubernetes.batch.v1.kotlin.inputs.CronJobSpecPatchArgs.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.
There is a newer version: 4.18.2.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

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

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import com.pulumi.kubernetes.batch.v1.inputs.CronJobSpecPatchArgs.builder
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName

/**
 * CronJobSpec describes how the job execution will look like and when it will actually run.
 * @property concurrencyPolicy Specifies how to treat concurrent executions of a Job. Valid values are:
 * - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
 * @property failedJobsHistoryLimit The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
 * @property jobTemplate Specifies the job that will be created when executing a CronJob.
 * @property schedule The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
 * @property startingDeadlineSeconds Optional deadline in seconds for starting the job if it misses scheduled time for any reason.  Missed jobs executions will be counted as failed ones.
 * @property successfulJobsHistoryLimit The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
 * @property suspend This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.  Defaults to false.
 * @property timeZone The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones
 */
public data class CronJobSpecPatchArgs(
    public val concurrencyPolicy: Output? = null,
    public val failedJobsHistoryLimit: Output? = null,
    public val jobTemplate: Output? = null,
    public val schedule: Output? = null,
    public val startingDeadlineSeconds: Output? = null,
    public val successfulJobsHistoryLimit: Output? = null,
    public val `suspend`: Output? = null,
    public val timeZone: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.kubernetes.batch.v1.inputs.CronJobSpecPatchArgs =
        com.pulumi.kubernetes.batch.v1.inputs.CronJobSpecPatchArgs.builder()
            .concurrencyPolicy(concurrencyPolicy?.applyValue({ args0 -> args0 }))
            .failedJobsHistoryLimit(failedJobsHistoryLimit?.applyValue({ args0 -> args0 }))
            .jobTemplate(jobTemplate?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .schedule(schedule?.applyValue({ args0 -> args0 }))
            .startingDeadlineSeconds(startingDeadlineSeconds?.applyValue({ args0 -> args0 }))
            .successfulJobsHistoryLimit(successfulJobsHistoryLimit?.applyValue({ args0 -> args0 }))
            .`suspend`(`suspend`?.applyValue({ args0 -> args0 }))
            .timeZone(timeZone?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [CronJobSpecPatchArgs].
 */
@PulumiTagMarker
public class CronJobSpecPatchArgsBuilder internal constructor() {
    private var concurrencyPolicy: Output? = null

    private var failedJobsHistoryLimit: Output? = null

    private var jobTemplate: Output? = null

    private var schedule: Output? = null

    private var startingDeadlineSeconds: Output? = null

    private var successfulJobsHistoryLimit: Output? = null

    private var `suspend`: Output? = null

    private var timeZone: Output? = null

    /**
     * @param value Specifies how to treat concurrent executions of a Job. Valid values are:
     * - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
     */
    @JvmName("ehajdclgdaufkegc")
    public suspend fun concurrencyPolicy(`value`: Output) {
        this.concurrencyPolicy = value
    }

    /**
     * @param value The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
     */
    @JvmName("bfxcxcnsxxvxqdxs")
    public suspend fun failedJobsHistoryLimit(`value`: Output) {
        this.failedJobsHistoryLimit = value
    }

    /**
     * @param value Specifies the job that will be created when executing a CronJob.
     */
    @JvmName("xsqivuyflphdlrsv")
    public suspend fun jobTemplate(`value`: Output) {
        this.jobTemplate = value
    }

    /**
     * @param value The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
     */
    @JvmName("sbgobvsngsdivdmw")
    public suspend fun schedule(`value`: Output) {
        this.schedule = value
    }

    /**
     * @param value Optional deadline in seconds for starting the job if it misses scheduled time for any reason.  Missed jobs executions will be counted as failed ones.
     */
    @JvmName("ruxajctjjcjcmrmh")
    public suspend fun startingDeadlineSeconds(`value`: Output) {
        this.startingDeadlineSeconds = value
    }

    /**
     * @param value The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
     */
    @JvmName("kvbfkqpjgyaueqve")
    public suspend fun successfulJobsHistoryLimit(`value`: Output) {
        this.successfulJobsHistoryLimit = value
    }

    /**
     * @param value This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.  Defaults to false.
     */
    @JvmName("eopivwbtktnaenls")
    public suspend fun `suspend`(`value`: Output) {
        this.`suspend` = value
    }

    /**
     * @param value The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones
     */
    @JvmName("jntjntuqoynhaicr")
    public suspend fun timeZone(`value`: Output) {
        this.timeZone = value
    }

    /**
     * @param value Specifies how to treat concurrent executions of a Job. Valid values are:
     * - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
     */
    @JvmName("uhnfsuucmisdqwsv")
    public suspend fun concurrencyPolicy(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.concurrencyPolicy = mapped
    }

    /**
     * @param value The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
     */
    @JvmName("xxkwgufahjxmiaqn")
    public suspend fun failedJobsHistoryLimit(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.failedJobsHistoryLimit = mapped
    }

    /**
     * @param value Specifies the job that will be created when executing a CronJob.
     */
    @JvmName("odfnrkrowfkxcxbm")
    public suspend fun jobTemplate(`value`: JobTemplateSpecPatchArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.jobTemplate = mapped
    }

    /**
     * @param argument Specifies the job that will be created when executing a CronJob.
     */
    @JvmName("baajalhpgcbyeipo")
    public suspend fun jobTemplate(argument: suspend JobTemplateSpecPatchArgsBuilder.() -> Unit) {
        val toBeMapped = JobTemplateSpecPatchArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.jobTemplate = mapped
    }

    /**
     * @param value The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
     */
    @JvmName("sutltokedrixovcy")
    public suspend fun schedule(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.schedule = mapped
    }

    /**
     * @param value Optional deadline in seconds for starting the job if it misses scheduled time for any reason.  Missed jobs executions will be counted as failed ones.
     */
    @JvmName("pslmvboirqwskajh")
    public suspend fun startingDeadlineSeconds(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.startingDeadlineSeconds = mapped
    }

    /**
     * @param value The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
     */
    @JvmName("ocbrfnaxxxjjhhky")
    public suspend fun successfulJobsHistoryLimit(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.successfulJobsHistoryLimit = mapped
    }

    /**
     * @param value This flag tells the controller to suspend subsequent executions, it does not apply to already started executions.  Defaults to false.
     */
    @JvmName("dbtwdlqyonwkywph")
    public suspend fun `suspend`(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.`suspend` = mapped
    }

    /**
     * @param value The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones
     */
    @JvmName("hlrrpqmovyewkpky")
    public suspend fun timeZone(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.timeZone = mapped
    }

    internal fun build(): CronJobSpecPatchArgs = CronJobSpecPatchArgs(
        concurrencyPolicy = concurrencyPolicy,
        failedJobsHistoryLimit = failedJobsHistoryLimit,
        jobTemplate = jobTemplate,
        schedule = schedule,
        startingDeadlineSeconds = startingDeadlineSeconds,
        successfulJobsHistoryLimit = successfulJobsHistoryLimit,
        `suspend` = `suspend`,
        timeZone = timeZone,
    )
}