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

package com.pulumi.gcp.dataplex.kotlin.inputs

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.dataplex.inputs.DatascanDataProfileSpecArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Double
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName

/**
 *
 * @property excludeFields The fields to exclude from data profile.
 * If specified, the fields will be excluded from data profile, regardless of `include_fields` value.
 * Structure is documented below.
 * @property includeFields The fields to include in data profile.
 * If not specified, all fields at the time of profile scan job execution are included, except for ones listed in `exclude_fields`.
 * Structure is documented below.
 * @property postScanActions Actions to take upon job completion.
 * Structure is documented below.
 * @property rowFilter A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10
 * @property samplingPercent The percentage of the records to be selected from the dataset for DataScan.
 * Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
 * Sampling is not applied if `sampling_percent` is not specified, 0 or 100.
 */
public data class DatascanDataProfileSpecArgs(
    public val excludeFields: Output? = null,
    public val includeFields: Output? = null,
    public val postScanActions: Output? = null,
    public val rowFilter: Output? = null,
    public val samplingPercent: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.dataplex.inputs.DatascanDataProfileSpecArgs =
        com.pulumi.gcp.dataplex.inputs.DatascanDataProfileSpecArgs.builder()
            .excludeFields(excludeFields?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .includeFields(includeFields?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .postScanActions(postScanActions?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .rowFilter(rowFilter?.applyValue({ args0 -> args0 }))
            .samplingPercent(samplingPercent?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [DatascanDataProfileSpecArgs].
 */
@PulumiTagMarker
public class DatascanDataProfileSpecArgsBuilder internal constructor() {
    private var excludeFields: Output? = null

    private var includeFields: Output? = null

    private var postScanActions: Output? = null

    private var rowFilter: Output? = null

    private var samplingPercent: Output? = null

    /**
     * @param value The fields to exclude from data profile.
     * If specified, the fields will be excluded from data profile, regardless of `include_fields` value.
     * Structure is documented below.
     */
    @JvmName("jlugejkxffieuylt")
    public suspend fun excludeFields(`value`: Output) {
        this.excludeFields = value
    }

    /**
     * @param value The fields to include in data profile.
     * If not specified, all fields at the time of profile scan job execution are included, except for ones listed in `exclude_fields`.
     * Structure is documented below.
     */
    @JvmName("ucfrojneepqyauvm")
    public suspend fun includeFields(`value`: Output) {
        this.includeFields = value
    }

    /**
     * @param value Actions to take upon job completion.
     * Structure is documented below.
     */
    @JvmName("pbdpdwakjhdntwgs")
    public suspend fun postScanActions(`value`: Output) {
        this.postScanActions = value
    }

    /**
     * @param value A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10
     */
    @JvmName("cxnslpidekhtgmnw")
    public suspend fun rowFilter(`value`: Output) {
        this.rowFilter = value
    }

    /**
     * @param value The percentage of the records to be selected from the dataset for DataScan.
     * Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
     * Sampling is not applied if `sampling_percent` is not specified, 0 or 100.
     */
    @JvmName("muxgnxveplubsgrt")
    public suspend fun samplingPercent(`value`: Output) {
        this.samplingPercent = value
    }

    /**
     * @param value The fields to exclude from data profile.
     * If specified, the fields will be excluded from data profile, regardless of `include_fields` value.
     * Structure is documented below.
     */
    @JvmName("eurkkasjlnjvunme")
    public suspend fun excludeFields(`value`: DatascanDataProfileSpecExcludeFieldsArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.excludeFields = mapped
    }

    /**
     * @param argument The fields to exclude from data profile.
     * If specified, the fields will be excluded from data profile, regardless of `include_fields` value.
     * Structure is documented below.
     */
    @JvmName("vjuvjtmoljldnsxf")
    public suspend fun excludeFields(argument: suspend DatascanDataProfileSpecExcludeFieldsArgsBuilder.() -> Unit) {
        val toBeMapped = DatascanDataProfileSpecExcludeFieldsArgsBuilder().applySuspend {
            argument()
        }.build()
        val mapped = of(toBeMapped)
        this.excludeFields = mapped
    }

    /**
     * @param value The fields to include in data profile.
     * If not specified, all fields at the time of profile scan job execution are included, except for ones listed in `exclude_fields`.
     * Structure is documented below.
     */
    @JvmName("fvihdousswgxxugj")
    public suspend fun includeFields(`value`: DatascanDataProfileSpecIncludeFieldsArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.includeFields = mapped
    }

    /**
     * @param argument The fields to include in data profile.
     * If not specified, all fields at the time of profile scan job execution are included, except for ones listed in `exclude_fields`.
     * Structure is documented below.
     */
    @JvmName("exsavsmdpfivsixa")
    public suspend fun includeFields(argument: suspend DatascanDataProfileSpecIncludeFieldsArgsBuilder.() -> Unit) {
        val toBeMapped = DatascanDataProfileSpecIncludeFieldsArgsBuilder().applySuspend {
            argument()
        }.build()
        val mapped = of(toBeMapped)
        this.includeFields = mapped
    }

    /**
     * @param value Actions to take upon job completion.
     * Structure is documented below.
     */
    @JvmName("xchevppocyccyvdc")
    public suspend fun postScanActions(`value`: DatascanDataProfileSpecPostScanActionsArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.postScanActions = mapped
    }

    /**
     * @param argument Actions to take upon job completion.
     * Structure is documented below.
     */
    @JvmName("cchixoehwdfgqtnw")
    public suspend fun postScanActions(argument: suspend DatascanDataProfileSpecPostScanActionsArgsBuilder.() -> Unit) {
        val toBeMapped = DatascanDataProfileSpecPostScanActionsArgsBuilder().applySuspend {
            argument()
        }.build()
        val mapped = of(toBeMapped)
        this.postScanActions = mapped
    }

    /**
     * @param value A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10
     */
    @JvmName("aggqlraaclvybwtg")
    public suspend fun rowFilter(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.rowFilter = mapped
    }

    /**
     * @param value The percentage of the records to be selected from the dataset for DataScan.
     * Value can range between 0.0 and 100.0 with up to 3 significant decimal digits.
     * Sampling is not applied if `sampling_percent` is not specified, 0 or 100.
     */
    @JvmName("gqidfgmgfpihskix")
    public suspend fun samplingPercent(`value`: Double?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.samplingPercent = mapped
    }

    internal fun build(): DatascanDataProfileSpecArgs = DatascanDataProfileSpecArgs(
        excludeFields = excludeFields,
        includeFields = includeFields,
        postScanActions = postScanActions,
        rowFilter = rowFilter,
        samplingPercent = samplingPercent,
    )
}