com.pulumi.gcp.bigquery.kotlin.inputs.ConnectionCloudSpannerArgs.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.13.1.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.bigquery.kotlin.inputs

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

/**
 *
 * @property database Cloud Spanner database in the form `project/instance/database'.
 * @property databaseRole Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as `SELECT` and `INSERT`. Other users should only use roles provided by their Cloud Spanner admins. The database role name must start with a letter, and can only contain letters, numbers, and underscores. For more details, see https://cloud.google.com/spanner/docs/fgac-about.
 * @property maxParallelism Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration. `useParallelism` and `useDataBoost` must be set when setting max parallelism.
 * @property useDataBoost If set, the request will be executed via Spanner independent compute resources. `use_parallelism` must be set when using data boost.
 * @property useParallelism If parallelism should be used when reading from Cloud Spanner.
 * @property useServerlessAnalytics (Optional, Deprecated)
 * If the serverless analytics service should be used to read data from Cloud Spanner. `useParallelism` must be set when using serverless analytics.
 * > **Warning:** `useServerlessAnalytics` is deprecated and will be removed in a future major release. Use `useDataBoost` instead.
 */
public data class ConnectionCloudSpannerArgs(
    public val database: Output,
    public val databaseRole: Output? = null,
    public val maxParallelism: Output? = null,
    public val useDataBoost: Output? = null,
    public val useParallelism: Output? = null,
    @Deprecated(
        message = """
  `useServerlessAnalytics` is deprecated and will be removed in a future major release. Use
      `useDataBoost` instead.
  """,
    )
    public val useServerlessAnalytics: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.bigquery.inputs.ConnectionCloudSpannerArgs =
        com.pulumi.gcp.bigquery.inputs.ConnectionCloudSpannerArgs.builder()
            .database(database.applyValue({ args0 -> args0 }))
            .databaseRole(databaseRole?.applyValue({ args0 -> args0 }))
            .maxParallelism(maxParallelism?.applyValue({ args0 -> args0 }))
            .useDataBoost(useDataBoost?.applyValue({ args0 -> args0 }))
            .useParallelism(useParallelism?.applyValue({ args0 -> args0 }))
            .useServerlessAnalytics(useServerlessAnalytics?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ConnectionCloudSpannerArgs].
 */
@PulumiTagMarker
public class ConnectionCloudSpannerArgsBuilder internal constructor() {
    private var database: Output? = null

    private var databaseRole: Output? = null

    private var maxParallelism: Output? = null

    private var useDataBoost: Output? = null

    private var useParallelism: Output? = null

    private var useServerlessAnalytics: Output? = null

    /**
     * @param value Cloud Spanner database in the form `project/instance/database'.
     */
    @JvmName("eqngcivbbacibgjx")
    public suspend fun database(`value`: Output) {
        this.database = value
    }

    /**
     * @param value Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as `SELECT` and `INSERT`. Other users should only use roles provided by their Cloud Spanner admins. The database role name must start with a letter, and can only contain letters, numbers, and underscores. For more details, see https://cloud.google.com/spanner/docs/fgac-about.
     */
    @JvmName("qtqfjtawnjushnll")
    public suspend fun databaseRole(`value`: Output) {
        this.databaseRole = value
    }

    /**
     * @param value Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration. `useParallelism` and `useDataBoost` must be set when setting max parallelism.
     */
    @JvmName("palpdiuyrbwgrnct")
    public suspend fun maxParallelism(`value`: Output) {
        this.maxParallelism = value
    }

    /**
     * @param value If set, the request will be executed via Spanner independent compute resources. `use_parallelism` must be set when using data boost.
     */
    @JvmName("hxqulvmrkcxgobjm")
    public suspend fun useDataBoost(`value`: Output) {
        this.useDataBoost = value
    }

    /**
     * @param value If parallelism should be used when reading from Cloud Spanner.
     */
    @JvmName("qawsqfjusgqvwnsi")
    public suspend fun useParallelism(`value`: Output) {
        this.useParallelism = value
    }

    /**
     * @param value (Optional, Deprecated)
     * If the serverless analytics service should be used to read data from Cloud Spanner. `useParallelism` must be set when using serverless analytics.
     * > **Warning:** `useServerlessAnalytics` is deprecated and will be removed in a future major release. Use `useDataBoost` instead.
     */
    @Deprecated(
        message = """
  `useServerlessAnalytics` is deprecated and will be removed in a future major release. Use
      `useDataBoost` instead.
  """,
    )
    @JvmName("droqvsbuexdoyehf")
    public suspend fun useServerlessAnalytics(`value`: Output) {
        this.useServerlessAnalytics = value
    }

    /**
     * @param value Cloud Spanner database in the form `project/instance/database'.
     */
    @JvmName("dsymqdaehixcbhhd")
    public suspend fun database(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.database = mapped
    }

    /**
     * @param value Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as `SELECT` and `INSERT`. Other users should only use roles provided by their Cloud Spanner admins. The database role name must start with a letter, and can only contain letters, numbers, and underscores. For more details, see https://cloud.google.com/spanner/docs/fgac-about.
     */
    @JvmName("mvvwlotjcefgwhei")
    public suspend fun databaseRole(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.databaseRole = mapped
    }

    /**
     * @param value Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration. `useParallelism` and `useDataBoost` must be set when setting max parallelism.
     */
    @JvmName("btblaotuisxwqfxs")
    public suspend fun maxParallelism(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.maxParallelism = mapped
    }

    /**
     * @param value If set, the request will be executed via Spanner independent compute resources. `use_parallelism` must be set when using data boost.
     */
    @JvmName("jtgscbvuypxeacoe")
    public suspend fun useDataBoost(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.useDataBoost = mapped
    }

    /**
     * @param value If parallelism should be used when reading from Cloud Spanner.
     */
    @JvmName("ydtjoggvvyprqlne")
    public suspend fun useParallelism(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.useParallelism = mapped
    }

    /**
     * @param value (Optional, Deprecated)
     * If the serverless analytics service should be used to read data from Cloud Spanner. `useParallelism` must be set when using serverless analytics.
     * > **Warning:** `useServerlessAnalytics` is deprecated and will be removed in a future major release. Use `useDataBoost` instead.
     */
    @Deprecated(
        message = """
  `useServerlessAnalytics` is deprecated and will be removed in a future major release. Use
      `useDataBoost` instead.
  """,
    )
    @JvmName("btuqqsbbvtngtemf")
    public suspend fun useServerlessAnalytics(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.useServerlessAnalytics = mapped
    }

    internal fun build(): ConnectionCloudSpannerArgs = ConnectionCloudSpannerArgs(
        database = database ?: throw PulumiNullFieldException("database"),
        databaseRole = databaseRole,
        maxParallelism = maxParallelism,
        useDataBoost = useDataBoost,
        useParallelism = useParallelism,
        useServerlessAnalytics = useServerlessAnalytics,
    )
}