com.pulumi.gcp.bigquery.kotlin.inputs.TableTimePartitioningArgs.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.10.0.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.TableTimePartitioningArgs.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 expirationMs Number of milliseconds for which to keep the
 * storage for a partition.
 * @property field The field used to determine how to create a time-based
 * partition. If time-based partitioning is enabled without this value, the
 * table is partitioned based on the load time.
 * @property requirePartitionFilter If set to true, queries over this table
 * require a partition filter that can be used for partition elimination to be
 * specified. `require_partition_filter` is deprecated and will be removed in
 * a future major release. Use the top level field with the same name instead.
 * @property type The supported types are DAY, HOUR, MONTH, and YEAR,
 * which will generate one partition per day, hour, month, and year, respectively.
 */
public data class TableTimePartitioningArgs(
    public val expirationMs: Output? = null,
    public val `field`: Output? = null,
    @Deprecated(
        message = """
  This field is deprecated and will be removed in a future major release; please use the top level
      field with the same name instead.
  """,
    )
    public val requirePartitionFilter: Output? = null,
    public val type: Output,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.bigquery.inputs.TableTimePartitioningArgs =
        com.pulumi.gcp.bigquery.inputs.TableTimePartitioningArgs.builder()
            .expirationMs(expirationMs?.applyValue({ args0 -> args0 }))
            .`field`(`field`?.applyValue({ args0 -> args0 }))
            .requirePartitionFilter(requirePartitionFilter?.applyValue({ args0 -> args0 }))
            .type(type.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [TableTimePartitioningArgs].
 */
@PulumiTagMarker
public class TableTimePartitioningArgsBuilder internal constructor() {
    private var expirationMs: Output? = null

    private var `field`: Output? = null

    private var requirePartitionFilter: Output? = null

    private var type: Output? = null

    /**
     * @param value Number of milliseconds for which to keep the
     * storage for a partition.
     */
    @JvmName("lmjuismkgyjfxscp")
    public suspend fun expirationMs(`value`: Output) {
        this.expirationMs = value
    }

    /**
     * @param value The field used to determine how to create a time-based
     * partition. If time-based partitioning is enabled without this value, the
     * table is partitioned based on the load time.
     */
    @JvmName("nnovfyeaythxnjcf")
    public suspend fun `field`(`value`: Output) {
        this.`field` = value
    }

    /**
     * @param value If set to true, queries over this table
     * require a partition filter that can be used for partition elimination to be
     * specified. `require_partition_filter` is deprecated and will be removed in
     * a future major release. Use the top level field with the same name instead.
     */
    @Deprecated(
        message = """
  This field is deprecated and will be removed in a future major release; please use the top level
      field with the same name instead.
  """,
    )
    @JvmName("htwfgpmawbmiqmru")
    public suspend fun requirePartitionFilter(`value`: Output) {
        this.requirePartitionFilter = value
    }

    /**
     * @param value The supported types are DAY, HOUR, MONTH, and YEAR,
     * which will generate one partition per day, hour, month, and year, respectively.
     */
    @JvmName("bkleaqdtgbjpmmjg")
    public suspend fun type(`value`: Output) {
        this.type = value
    }

    /**
     * @param value Number of milliseconds for which to keep the
     * storage for a partition.
     */
    @JvmName("jengauccjkoctala")
    public suspend fun expirationMs(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.expirationMs = mapped
    }

    /**
     * @param value The field used to determine how to create a time-based
     * partition. If time-based partitioning is enabled without this value, the
     * table is partitioned based on the load time.
     */
    @JvmName("egnccpryavmhmpfa")
    public suspend fun `field`(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.`field` = mapped
    }

    /**
     * @param value If set to true, queries over this table
     * require a partition filter that can be used for partition elimination to be
     * specified. `require_partition_filter` is deprecated and will be removed in
     * a future major release. Use the top level field with the same name instead.
     */
    @Deprecated(
        message = """
  This field is deprecated and will be removed in a future major release; please use the top level
      field with the same name instead.
  """,
    )
    @JvmName("xbnsvmfjhyrqsnxa")
    public suspend fun requirePartitionFilter(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.requirePartitionFilter = mapped
    }

    /**
     * @param value The supported types are DAY, HOUR, MONTH, and YEAR,
     * which will generate one partition per day, hour, month, and year, respectively.
     */
    @JvmName("srbowmyweqqhmpbj")
    public suspend fun type(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.type = mapped
    }

    internal fun build(): TableTimePartitioningArgs = TableTimePartitioningArgs(
        expirationMs = expirationMs,
        `field` = `field`,
        requirePartitionFilter = requirePartitionFilter,
        type = type ?: throw PulumiNullFieldException("type"),
    )
}