com.pulumi.kubernetes.resource.v1alpha3.kotlin.inputs.DeviceRequestArgs.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.resource.v1alpha3.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.resource.v1alpha3.inputs.DeviceRequestArgs.builder
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices.
 * A DeviceClassName is currently required. Clients must check that it is indeed set. It's absence indicates that something changed in a way that is not supported by the client yet, in which case it must refuse to handle the request.
 * @property adminAccess AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device.  They ignore all ordinary claims to the device with respect to access modes and any resource allocations.
 * @property allocationMode AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:
 * - ExactCount: This request is for a specific number of devices.
 *   This is the default. The exact number is provided in the
 *   count field.
 * - All: This request is for all of the matching devices in a pool.
 *   Allocation will fail if some devices are already allocated,
 *   unless adminAccess is requested.
 * If AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.
 * More modes may get added in the future. Clients must refuse to handle requests with unknown modes.
 * @property count Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
 * @property deviceClassName DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.
 * A class is required. Which classes are available depends on the cluster.
 * Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.
 * @property name Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim.
 * Must be a DNS label.
 * @property selectors Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
 */
public data class DeviceRequestArgs(
    public val adminAccess: Output? = null,
    public val allocationMode: Output? = null,
    public val count: Output? = null,
    public val deviceClassName: Output,
    public val name: Output,
    public val selectors: Output>? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.kubernetes.resource.v1alpha3.inputs.DeviceRequestArgs =
        com.pulumi.kubernetes.resource.v1alpha3.inputs.DeviceRequestArgs.builder()
            .adminAccess(adminAccess?.applyValue({ args0 -> args0 }))
            .allocationMode(allocationMode?.applyValue({ args0 -> args0 }))
            .count(count?.applyValue({ args0 -> args0 }))
            .deviceClassName(deviceClassName.applyValue({ args0 -> args0 }))
            .name(name.applyValue({ args0 -> args0 }))
            .selectors(
                selectors?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.let({ args0 ->
                            args0.toJava()
                        })
                    })
                }),
            ).build()
}

/**
 * Builder for [DeviceRequestArgs].
 */
@PulumiTagMarker
public class DeviceRequestArgsBuilder internal constructor() {
    private var adminAccess: Output? = null

    private var allocationMode: Output? = null

    private var count: Output? = null

    private var deviceClassName: Output? = null

    private var name: Output? = null

    private var selectors: Output>? = null

    /**
     * @param value AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device.  They ignore all ordinary claims to the device with respect to access modes and any resource allocations.
     */
    @JvmName("tgokedlvsbykpudw")
    public suspend fun adminAccess(`value`: Output) {
        this.adminAccess = value
    }

    /**
     * @param value AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:
     * - ExactCount: This request is for a specific number of devices.
     *   This is the default. The exact number is provided in the
     *   count field.
     * - All: This request is for all of the matching devices in a pool.
     *   Allocation will fail if some devices are already allocated,
     *   unless adminAccess is requested.
     * If AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.
     * More modes may get added in the future. Clients must refuse to handle requests with unknown modes.
     */
    @JvmName("sogkcmisjqioxrvg")
    public suspend fun allocationMode(`value`: Output) {
        this.allocationMode = value
    }

    /**
     * @param value Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
     */
    @JvmName("qnojjtylccuuifpp")
    public suspend fun count(`value`: Output) {
        this.count = value
    }

    /**
     * @param value DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.
     * A class is required. Which classes are available depends on the cluster.
     * Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.
     */
    @JvmName("pyiypbcbtmxqlabu")
    public suspend fun deviceClassName(`value`: Output) {
        this.deviceClassName = value
    }

    /**
     * @param value Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim.
     * Must be a DNS label.
     */
    @JvmName("ulkakexhujaocmxn")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
     */
    @JvmName("tuhhtoihmpbtoejb")
    public suspend fun selectors(`value`: Output>) {
        this.selectors = value
    }

    @JvmName("cbxldghogcfnqvee")
    public suspend fun selectors(vararg values: Output) {
        this.selectors = Output.all(values.asList())
    }

    /**
     * @param values Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
     */
    @JvmName("ttyqfeqbijdcmnpf")
    public suspend fun selectors(values: List>) {
        this.selectors = Output.all(values)
    }

    /**
     * @param value AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device.  They ignore all ordinary claims to the device with respect to access modes and any resource allocations.
     */
    @JvmName("axwhctccmuxcxyde")
    public suspend fun adminAccess(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.adminAccess = mapped
    }

    /**
     * @param value AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are:
     * - ExactCount: This request is for a specific number of devices.
     *   This is the default. The exact number is provided in the
     *   count field.
     * - All: This request is for all of the matching devices in a pool.
     *   Allocation will fail if some devices are already allocated,
     *   unless adminAccess is requested.
     * If AlloctionMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other requests must specify this field.
     * More modes may get added in the future. Clients must refuse to handle requests with unknown modes.
     */
    @JvmName("skgntlwxiwlqkrhn")
    public suspend fun allocationMode(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.allocationMode = mapped
    }

    /**
     * @param value Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
     */
    @JvmName("losobpvvjiqchmex")
    public suspend fun count(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.count = mapped
    }

    /**
     * @param value DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request.
     * A class is required. Which classes are available depends on the cluster.
     * Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.
     */
    @JvmName("weuuhapyxclhcquw")
    public suspend fun deviceClassName(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.deviceClassName = mapped
    }

    /**
     * @param value Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim.
     * Must be a DNS label.
     */
    @JvmName("eitjhdnogotmfgba")
    public suspend fun name(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
     */
    @JvmName("lqrrxxqchegrtdao")
    public suspend fun selectors(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.selectors = mapped
    }

    /**
     * @param argument Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
     */
    @JvmName("tgthesupiuhlqjsg")
    public suspend fun selectors(argument: List Unit>) {
        val toBeMapped = argument.toList().map {
            DeviceSelectorArgsBuilder().applySuspend {
                it()
            }.build()
        }
        val mapped = of(toBeMapped)
        this.selectors = mapped
    }

    /**
     * @param argument Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
     */
    @JvmName("sweaxksdgnyrbrlj")
    public suspend fun selectors(vararg argument: suspend DeviceSelectorArgsBuilder.() -> Unit) {
        val toBeMapped = argument.toList().map {
            DeviceSelectorArgsBuilder().applySuspend {
                it()
            }.build()
        }
        val mapped = of(toBeMapped)
        this.selectors = mapped
    }

    /**
     * @param argument Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
     */
    @JvmName("uymdiacdbijjyvqh")
    public suspend fun selectors(argument: suspend DeviceSelectorArgsBuilder.() -> Unit) {
        val toBeMapped = listOf(DeviceSelectorArgsBuilder().applySuspend { argument() }.build())
        val mapped = of(toBeMapped)
        this.selectors = mapped
    }

    /**
     * @param values Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
     */
    @JvmName("gpatmwmqaeeofpvi")
    public suspend fun selectors(vararg values: DeviceSelectorArgs) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.selectors = mapped
    }

    internal fun build(): DeviceRequestArgs = DeviceRequestArgs(
        adminAccess = adminAccess,
        allocationMode = allocationMode,
        count = count,
        deviceClassName = deviceClassName ?: throw PulumiNullFieldException("deviceClassName"),
        name = name ?: throw PulumiNullFieldException("name"),
        selectors = selectors,
    )
}