com.pulumi.gcp.dataplex.kotlin.inputs.TaskTriggerSpecArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-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: 8.10.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.dataplex.kotlin.inputs

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.dataplex.inputs.TaskTriggerSpecArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 *
 * @property disabled Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
 * @property maxRetries Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.
 * @property schedule Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: 'CRON_TZ=${IANA_TIME_ZONE}' or 'TZ=${IANA_TIME_ZONE}'. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.
 * @property startTime The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.
 * @property type Trigger type of the user-specified Task
 * Possible values are: `ON_DEMAND`, `RECURRING`.
 */
public data class TaskTriggerSpecArgs(
    public val disabled: Output? = null,
    public val maxRetries: Output? = null,
    public val schedule: Output? = null,
    public val startTime: Output? = null,
    public val type: Output,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.dataplex.inputs.TaskTriggerSpecArgs =
        com.pulumi.gcp.dataplex.inputs.TaskTriggerSpecArgs.builder()
            .disabled(disabled?.applyValue({ args0 -> args0 }))
            .maxRetries(maxRetries?.applyValue({ args0 -> args0 }))
            .schedule(schedule?.applyValue({ args0 -> args0 }))
            .startTime(startTime?.applyValue({ args0 -> args0 }))
            .type(type.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [TaskTriggerSpecArgs].
 */
@PulumiTagMarker
public class TaskTriggerSpecArgsBuilder internal constructor() {
    private var disabled: Output? = null

    private var maxRetries: Output? = null

    private var schedule: Output? = null

    private var startTime: Output? = null

    private var type: Output? = null

    /**
     * @param value Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
     */
    @JvmName("hravomcwhilwvqxe")
    public suspend fun disabled(`value`: Output) {
        this.disabled = value
    }

    /**
     * @param value Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.
     */
    @JvmName("kcufcngodcbctqhg")
    public suspend fun maxRetries(`value`: Output) {
        this.maxRetries = value
    }

    /**
     * @param value Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: 'CRON_TZ=${IANA_TIME_ZONE}' or 'TZ=${IANA_TIME_ZONE}'. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.
     */
    @JvmName("uxihpdgksxbnlkxw")
    public suspend fun schedule(`value`: Output) {
        this.schedule = value
    }

    /**
     * @param value The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.
     */
    @JvmName("dfrgjhcpjoxifkfv")
    public suspend fun startTime(`value`: Output) {
        this.startTime = value
    }

    /**
     * @param value Trigger type of the user-specified Task
     * Possible values are: `ON_DEMAND`, `RECURRING`.
     */
    @JvmName("bnqsrijxclujgaff")
    public suspend fun type(`value`: Output) {
        this.type = value
    }

    /**
     * @param value Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
     */
    @JvmName("wppjmyhpxwwaulii")
    public suspend fun disabled(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.disabled = mapped
    }

    /**
     * @param value Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.
     */
    @JvmName("ytqqfdqwstcngwlw")
    public suspend fun maxRetries(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.maxRetries = mapped
    }

    /**
     * @param value Cron schedule (https://en.wikipedia.org/wiki/Cron) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: 'CRON_TZ=${IANA_TIME_ZONE}' or 'TZ=${IANA_TIME_ZONE}'. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *. This field is required for RECURRING tasks.
     */
    @JvmName("uogfyjtrncdqfilh")
    public suspend fun schedule(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.schedule = mapped
    }

    /**
     * @param value The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.
     */
    @JvmName("mrnlflgxekncxjgr")
    public suspend fun startTime(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.startTime = mapped
    }

    /**
     * @param value Trigger type of the user-specified Task
     * Possible values are: `ON_DEMAND`, `RECURRING`.
     */
    @JvmName("bgyrvqummxcmarcu")
    public suspend fun type(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.type = mapped
    }

    internal fun build(): TaskTriggerSpecArgs = TaskTriggerSpecArgs(
        disabled = disabled,
        maxRetries = maxRetries,
        schedule = schedule,
        startTime = startTime,
        type = type ?: throw PulumiNullFieldException("type"),
    )
}