com.pulumi.kubernetes.batch.v1beta1.kotlin.inputs.CronJobSpecArgs.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.v1beta1.kotlin.inputs

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import com.pulumi.kubernetes.batch.v1beta1.inputs.CronJobSpecArgs.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. This is a pointer to distinguish between explicit zero and not specified. 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. This is a pointer to distinguish between explicit zero and not specified. 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.
 */
public data class CronJobSpecArgs(
    public val concurrencyPolicy: Output? = null,
    public val failedJobsHistoryLimit: Output? = null,
    public val jobTemplate: Output,
    public val schedule: Output,
    public val startingDeadlineSeconds: Output? = null,
    public val successfulJobsHistoryLimit: Output? = null,
    public val `suspend`: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.kubernetes.batch.v1beta1.inputs.CronJobSpecArgs =
        com.pulumi.kubernetes.batch.v1beta1.inputs.CronJobSpecArgs.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 })).build()
}

/**
 * Builder for [CronJobSpecArgs].
 */
@PulumiTagMarker
public class CronJobSpecArgsBuilder 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

    /**
     * @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("xqpwvvmqjldumxru")
    public suspend fun concurrencyPolicy(`value`: Output) {
        this.concurrencyPolicy = value
    }

    /**
     * @param value The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
     */
    @JvmName("atbfxkjjkpssmppg")
    public suspend fun failedJobsHistoryLimit(`value`: Output) {
        this.failedJobsHistoryLimit = value
    }

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

    /**
     * @param value The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
     */
    @JvmName("cylfilalvdameukw")
    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("oxqrdlifnyaqupjc")
    public suspend fun startingDeadlineSeconds(`value`: Output) {
        this.startingDeadlineSeconds = value
    }

    /**
     * @param value The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
     */
    @JvmName("weruikbmjfkexdas")
    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("nghoeieethiltftu")
    public suspend fun `suspend`(`value`: Output) {
        this.`suspend` = 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("bsndvrgalknwwuyn")
    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. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
     */
    @JvmName("svfyqwtayskxmqku")
    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("kfabjgflimvciqck")
    public suspend fun jobTemplate(`value`: JobTemplateSpecArgs) {
        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("aykywhudetlbetnx")
    public suspend fun jobTemplate(argument: suspend JobTemplateSpecArgsBuilder.() -> Unit) {
        val toBeMapped = JobTemplateSpecArgsBuilder().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("ryxvmdbdrefmynmd")
    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("crgyaqsqbgllkayx")
    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. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3.
     */
    @JvmName("mbqfpnarrhwciumb")
    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("lkrxslprdwdbvjmk")
    public suspend fun `suspend`(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.`suspend` = mapped
    }

    internal fun build(): CronJobSpecArgs = CronJobSpecArgs(
        concurrencyPolicy = concurrencyPolicy,
        failedJobsHistoryLimit = failedJobsHistoryLimit,
        jobTemplate = jobTemplate ?: throw PulumiNullFieldException("jobTemplate"),
        schedule = schedule ?: throw PulumiNullFieldException("schedule"),
        startingDeadlineSeconds = startingDeadlineSeconds,
        successfulJobsHistoryLimit = successfulJobsHistoryLimit,
        `suspend` = `suspend`,
    )
}