commonMain.aws.sdk.kotlin.services.cloudsearch.model.DescribeIndexFieldsRequest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudsearch-jvm Show documentation
The AWS SDK for Kotlin client for CloudSearch
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.cloudsearch.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Container for the parameters to the `DescribeIndexFields` operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the `Deployed` option to `true`.
 */
public class DescribeIndexFieldsRequest private constructor(builder: Builder) {
    /**
     * Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.
     */
    public val deployed: kotlin.Boolean? = builder.deployed
    /**
     * The name of the domain you want to describe.
     */
    public val domainName: kotlin.String? = builder.domainName
    /**
     * A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
     */
    public val fieldNames: List? = builder.fieldNames

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

    override fun toString(): kotlin.String = buildString {
        append("DescribeIndexFieldsRequest(")
        append("deployed=$deployed,")
        append("domainName=$domainName,")
        append("fieldNames=$fieldNames")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = deployed?.hashCode() ?: 0
        result = 31 * result + (domainName?.hashCode() ?: 0)
        result = 31 * result + (fieldNames?.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 DescribeIndexFieldsRequest

        if (deployed != other.deployed) return false
        if (domainName != other.domainName) return false
        if (fieldNames != other.fieldNames) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Whether to display the deployed configuration (`true`) or include any pending changes (`false`). Defaults to `false`.
         */
        public var deployed: kotlin.Boolean? = null
        /**
         * The name of the domain you want to describe.
         */
        public var domainName: kotlin.String? = null
        /**
         * A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
         */
        public var fieldNames: List? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.cloudsearch.model.DescribeIndexFieldsRequest) : this() {
            this.deployed = x.deployed
            this.domainName = x.domainName
            this.fieldNames = x.fieldNames
        }

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

        internal fun correctErrors(): Builder {
            return this
        }
    }
}