com.pulumi.googlenative.cloudscheduler.v1beta1.kotlin.inputs.RetryConfigArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-google-native-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.googlenative.cloudscheduler.v1beta1.kotlin.inputs

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.googlenative.cloudscheduler.v1beta1.inputs.RetryConfigArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * Settings that determine the retry behavior. By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.
 * @property maxBackoffDuration The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
 * @property maxDoublings The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
 * @property maxRetryDuration The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
 * @property minBackoffDuration The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
 * @property retryCount The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
 */
public data class RetryConfigArgs(
    public val maxBackoffDuration: Output? = null,
    public val maxDoublings: Output? = null,
    public val maxRetryDuration: Output? = null,
    public val minBackoffDuration: Output? = null,
    public val retryCount: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.googlenative.cloudscheduler.v1beta1.inputs.RetryConfigArgs =
        com.pulumi.googlenative.cloudscheduler.v1beta1.inputs.RetryConfigArgs.builder()
            .maxBackoffDuration(maxBackoffDuration?.applyValue({ args0 -> args0 }))
            .maxDoublings(maxDoublings?.applyValue({ args0 -> args0 }))
            .maxRetryDuration(maxRetryDuration?.applyValue({ args0 -> args0 }))
            .minBackoffDuration(minBackoffDuration?.applyValue({ args0 -> args0 }))
            .retryCount(retryCount?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [RetryConfigArgs].
 */
@PulumiTagMarker
public class RetryConfigArgsBuilder internal constructor() {
    private var maxBackoffDuration: Output? = null

    private var maxDoublings: Output? = null

    private var maxRetryDuration: Output? = null

    private var minBackoffDuration: Output? = null

    private var retryCount: Output? = null

    /**
     * @param value The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
     */
    @JvmName("jgwvnwtwartmntmj")
    public suspend fun maxBackoffDuration(`value`: Output) {
        this.maxBackoffDuration = value
    }

    /**
     * @param value The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
     */
    @JvmName("qwlhpppaifodxwou")
    public suspend fun maxDoublings(`value`: Output) {
        this.maxDoublings = value
    }

    /**
     * @param value The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
     */
    @JvmName("netsprnyyjwckqrj")
    public suspend fun maxRetryDuration(`value`: Output) {
        this.maxRetryDuration = value
    }

    /**
     * @param value The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     */
    @JvmName("jrummvichsbogelh")
    public suspend fun minBackoffDuration(`value`: Output) {
        this.minBackoffDuration = value
    }

    /**
     * @param value The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
     */
    @JvmName("vifgcgrdxrcrmurj")
    public suspend fun retryCount(`value`: Output) {
        this.retryCount = value
    }

    /**
     * @param value The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
     */
    @JvmName("jodkjlcijydqecft")
    public suspend fun maxBackoffDuration(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.maxBackoffDuration = mapped
    }

    /**
     * @param value The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
     */
    @JvmName("lgcxirgovgpjbaeo")
    public suspend fun maxDoublings(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.maxDoublings = mapped
    }

    /**
     * @param value The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
     */
    @JvmName("lyoiyntrgvfddklt")
    public suspend fun maxRetryDuration(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.maxRetryDuration = mapped
    }

    /**
     * @param value The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     */
    @JvmName("pkmirtpxraacjviv")
    public suspend fun minBackoffDuration(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.minBackoffDuration = mapped
    }

    /**
     * @param value The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.
     */
    @JvmName("oqjlhbcxwjchguul")
    public suspend fun retryCount(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.retryCount = mapped
    }

    internal fun build(): RetryConfigArgs = RetryConfigArgs(
        maxBackoffDuration = maxBackoffDuration,
        maxDoublings = maxDoublings,
        maxRetryDuration = maxRetryDuration,
        minBackoffDuration = minBackoffDuration,
        retryCount = retryCount,
    )
}