com.pulumi.kubernetes.resource.v1alpha3.kotlin.ResourceSlice.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.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.kubernetes.resource.v1alpha3.kotlin

import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMeta
import com.pulumi.kubernetes.resource.v1alpha3.kotlin.outputs.ResourceSliceSpec
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMeta.Companion.toKotlin as objectMetaToKotlin
import com.pulumi.kubernetes.resource.v1alpha3.kotlin.outputs.ResourceSliceSpec.Companion.toKotlin as resourceSliceSpecToKotlin

/**
 * Builder for [ResourceSlice].
 */
@PulumiTagMarker
public class ResourceSliceResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ResourceSliceArgs = ResourceSliceArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend ResourceSliceArgsBuilder.() -> Unit) {
        val builder = ResourceSliceArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): ResourceSlice {
        val builtJavaResource =
            com.pulumi.kubernetes.resource.v1alpha3.ResourceSlice(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return ResourceSlice(builtJavaResource)
    }
}

/**
 * ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver.
 * At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple , , .
 * Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others.
 * When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool.
 * For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available.
 * This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.
 */
public class ResourceSlice internal constructor(
    override val javaResource: com.pulumi.kubernetes.resource.v1alpha3.ResourceSlice,
) : KotlinCustomResource(javaResource, ResourceSliceMapper) {
    /**
     * APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
     */
    public val apiVersion: Output
        get() = javaResource.apiVersion().applyValue({ args0 -> args0 })

    /**
     * Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
     */
    public val kind: Output
        get() = javaResource.kind().applyValue({ args0 -> args0 })

    /**
     * Standard object metadata
     */
    public val metadata: Output
        get() = javaResource.metadata().applyValue({ args0 ->
            args0.let({ args0 ->
                objectMetaToKotlin(args0)
            })
        })

    /**
     * Contains the information published by the driver.
     * Changing the spec automatically increments the metadata.generation number.
     */
    public val spec: Output
        get() = javaResource.spec().applyValue({ args0 ->
            args0.let({ args0 ->
                resourceSliceSpecToKotlin(args0)
            })
        })
}

public object ResourceSliceMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.kubernetes.resource.v1alpha3.ResourceSlice::class == javaResource::class

    override fun map(javaResource: Resource): ResourceSlice = ResourceSlice(
        javaResource as
            com.pulumi.kubernetes.resource.v1alpha3.ResourceSlice,
    )
}

/**
 * @see [ResourceSlice].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [ResourceSlice].
 */
public suspend fun resourceSlice(
    name: String,
    block: suspend ResourceSliceResourceBuilder.() -> Unit,
): ResourceSlice {
    val builder = ResourceSliceResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [ResourceSlice].
 * @param name The _unique_ name of the resulting resource.
 */
public fun resourceSlice(name: String): ResourceSlice {
    val builder = ResourceSliceResourceBuilder()
    builder.name(name)
    return builder.build()
}