commonMain.aws.sdk.kotlin.services.databrew.model.DatasetParameter.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of databrew-jvm Show documentation
The AWS Kotlin client for DataBrew
There is a newer version: 1.3.99
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.databrew.model



/**
 * Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset.
 */
public class DatasetParameter private constructor(builder: Builder) {
    /**
     * Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
     */
    public val createColumn: kotlin.Boolean = builder.createColumn
    /**
     * Additional parameter options such as a format and a timezone. Required for datetime parameters.
     */
    public val datetimeOptions: aws.sdk.kotlin.services.databrew.model.DatetimeOptions? = builder.datetimeOptions
    /**
     * The optional filter expression structure to apply additional matching criteria to the parameter.
     */
    public val filter: aws.sdk.kotlin.services.databrew.model.FilterExpression? = builder.filter
    /**
     * The name of the parameter that is used in the dataset's Amazon S3 path.
     */
    public val name: kotlin.String? = builder.name
    /**
     * The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
     */
    public val type: aws.sdk.kotlin.services.databrew.model.ParameterType? = builder.type

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.databrew.model.DatasetParameter = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("DatasetParameter(")
        append("createColumn=$createColumn,")
        append("datetimeOptions=$datetimeOptions,")
        append("filter=$filter,")
        append("name=$name,")
        append("type=$type)")
    }

    override fun hashCode(): kotlin.Int {
        var result = createColumn.hashCode()
        result = 31 * result + (datetimeOptions?.hashCode() ?: 0)
        result = 31 * result + (filter?.hashCode() ?: 0)
        result = 31 * result + (name?.hashCode() ?: 0)
        result = 31 * result + (type?.hashCode() ?: 0)
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as DatasetParameter

        if (createColumn != other.createColumn) return false
        if (datetimeOptions != other.datetimeOptions) return false
        if (filter != other.filter) return false
        if (name != other.name) return false
        if (type != other.type) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.databrew.model.DatasetParameter = Builder(this).apply(block).build()

    public class Builder {
        /**
         * Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
         */
        public var createColumn: kotlin.Boolean = false
        /**
         * Additional parameter options such as a format and a timezone. Required for datetime parameters.
         */
        public var datetimeOptions: aws.sdk.kotlin.services.databrew.model.DatetimeOptions? = null
        /**
         * The optional filter expression structure to apply additional matching criteria to the parameter.
         */
        public var filter: aws.sdk.kotlin.services.databrew.model.FilterExpression? = null
        /**
         * The name of the parameter that is used in the dataset's Amazon S3 path.
         */
        public var name: kotlin.String? = null
        /**
         * The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
         */
        public var type: aws.sdk.kotlin.services.databrew.model.ParameterType? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.databrew.model.DatasetParameter) : this() {
            this.createColumn = x.createColumn
            this.datetimeOptions = x.datetimeOptions
            this.filter = x.filter
            this.name = x.name
            this.type = x.type
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.databrew.model.DatasetParameter = DatasetParameter(this)

        /**
         * construct an [aws.sdk.kotlin.services.databrew.model.DatetimeOptions] inside the given [block]
         */
        public fun datetimeOptions(block: aws.sdk.kotlin.services.databrew.model.DatetimeOptions.Builder.() -> kotlin.Unit) {
            this.datetimeOptions = aws.sdk.kotlin.services.databrew.model.DatetimeOptions.invoke(block)
        }

        /**
         * construct an [aws.sdk.kotlin.services.databrew.model.FilterExpression] inside the given [block]
         */
        public fun filter(block: aws.sdk.kotlin.services.databrew.model.FilterExpression.Builder.() -> kotlin.Unit) {
            this.filter = aws.sdk.kotlin.services.databrew.model.FilterExpression.invoke(block)
        }
    }
}