com.pulumi.azure.cognitive.kotlin.inputs.DeploymentScaleArgs.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.cognitive.kotlin.inputs

import com.pulumi.azure.cognitive.inputs.DeploymentScaleArgs.builder
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 kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 *
 * @property capacity Tokens-per-Minute (TPM). The unit of measure for this field is in the thousands of Tokens-per-Minute. Defaults to `1` which means that the limitation is `1000` tokens per minute. If the resources SKU supports scale in/out then the capacity field should be included in the resources' configuration. If the scale in/out is not supported by the resources SKU then this field can be safely omitted. For more information about TPM please see the [product documentation](https://learn.microsoft.com/azure/ai-services/openai/how-to/quota?tabs=rest).
 * @property family If the service has different generations of hardware, for the same SKU, then that can be captured here. Changing this forces a new resource to be created.
 * @property size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. Changing this forces a new resource to be created.
 * @property tier Possible values are `Free`, `Basic`, `Standard`, `Premium`, `Enterprise`. Changing this forces a new resource to be created.
 * @property type The name of the SKU. Ex - `Standard` or `P3`. It is typically a letter+number code. Changing this forces a new resource to be created.
 */
public data class DeploymentScaleArgs(
    public val capacity: Output? = null,
    public val family: Output? = null,
    public val size: Output? = null,
    public val tier: Output? = null,
    public val type: Output,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.cognitive.inputs.DeploymentScaleArgs =
        com.pulumi.azure.cognitive.inputs.DeploymentScaleArgs.builder()
            .capacity(capacity?.applyValue({ args0 -> args0 }))
            .family(family?.applyValue({ args0 -> args0 }))
            .size(size?.applyValue({ args0 -> args0 }))
            .tier(tier?.applyValue({ args0 -> args0 }))
            .type(type.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [DeploymentScaleArgs].
 */
@PulumiTagMarker
public class DeploymentScaleArgsBuilder internal constructor() {
    private var capacity: Output? = null

    private var family: Output? = null

    private var size: Output? = null

    private var tier: Output? = null

    private var type: Output? = null

    /**
     * @param value Tokens-per-Minute (TPM). The unit of measure for this field is in the thousands of Tokens-per-Minute. Defaults to `1` which means that the limitation is `1000` tokens per minute. If the resources SKU supports scale in/out then the capacity field should be included in the resources' configuration. If the scale in/out is not supported by the resources SKU then this field can be safely omitted. For more information about TPM please see the [product documentation](https://learn.microsoft.com/azure/ai-services/openai/how-to/quota?tabs=rest).
     */
    @JvmName("ukwxvjopdfdbfpnv")
    public suspend fun capacity(`value`: Output) {
        this.capacity = value
    }

    /**
     * @param value If the service has different generations of hardware, for the same SKU, then that can be captured here. Changing this forces a new resource to be created.
     */
    @JvmName("utskwhcrloopcisv")
    public suspend fun family(`value`: Output) {
        this.family = value
    }

    /**
     * @param value The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. Changing this forces a new resource to be created.
     */
    @JvmName("ualbgsivnqruwhfe")
    public suspend fun size(`value`: Output) {
        this.size = value
    }

    /**
     * @param value Possible values are `Free`, `Basic`, `Standard`, `Premium`, `Enterprise`. Changing this forces a new resource to be created.
     */
    @JvmName("fferhvlrnevlielq")
    public suspend fun tier(`value`: Output) {
        this.tier = value
    }

    /**
     * @param value The name of the SKU. Ex - `Standard` or `P3`. It is typically a letter+number code. Changing this forces a new resource to be created.
     */
    @JvmName("ujelgjpyxygphylj")
    public suspend fun type(`value`: Output) {
        this.type = value
    }

    /**
     * @param value Tokens-per-Minute (TPM). The unit of measure for this field is in the thousands of Tokens-per-Minute. Defaults to `1` which means that the limitation is `1000` tokens per minute. If the resources SKU supports scale in/out then the capacity field should be included in the resources' configuration. If the scale in/out is not supported by the resources SKU then this field can be safely omitted. For more information about TPM please see the [product documentation](https://learn.microsoft.com/azure/ai-services/openai/how-to/quota?tabs=rest).
     */
    @JvmName("umiuevncmviemqxg")
    public suspend fun capacity(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.capacity = mapped
    }

    /**
     * @param value If the service has different generations of hardware, for the same SKU, then that can be captured here. Changing this forces a new resource to be created.
     */
    @JvmName("phbcftsmqchsndhx")
    public suspend fun family(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.family = mapped
    }

    /**
     * @param value The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. Changing this forces a new resource to be created.
     */
    @JvmName("nsarvcbwawamlkig")
    public suspend fun size(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.size = mapped
    }

    /**
     * @param value Possible values are `Free`, `Basic`, `Standard`, `Premium`, `Enterprise`. Changing this forces a new resource to be created.
     */
    @JvmName("oxhwwfvnrgrmstvu")
    public suspend fun tier(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.tier = mapped
    }

    /**
     * @param value The name of the SKU. Ex - `Standard` or `P3`. It is typically a letter+number code. Changing this forces a new resource to be created.
     */
    @JvmName("mnkwomujgayuxpbs")
    public suspend fun type(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.type = mapped
    }

    internal fun build(): DeploymentScaleArgs = DeploymentScaleArgs(
        capacity = capacity,
        family = family,
        size = size,
        tier = tier,
        type = type ?: throw PulumiNullFieldException("type"),
    )
}