commonMain.aws.sdk.kotlin.services.kendra.model.UpdateFeaturedResultsSetRequest.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.kendra.model



public class UpdateFeaturedResultsSetRequest private constructor(builder: Builder) {
    /**
     * A new description for the set of featured results.
     */
    public val description: kotlin.String? = builder.description
    /**
     * A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
     */
    public val featuredDocuments: List? = builder.featuredDocuments
    /**
     * The identifier of the set of featured results that you want to update.
     */
    public val featuredResultsSetId: kotlin.String? = builder.featuredResultsSetId
    /**
     * A new name for the set of featured results.
     */
    public val featuredResultsSetName: kotlin.String? = builder.featuredResultsSetName
    /**
     * The identifier of the index used for featuring results.
     */
    public val indexId: kotlin.String? = builder.indexId
    /**
     * A list of queries for featuring results. For more information on the list of queries, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
     */
    public val queryTexts: List? = builder.queryTexts
    /**
     * You can set the status to `ACTIVE` or `INACTIVE`. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. The queries you specify for featured results must be unique per featured results set for each index, whether the status is `ACTIVE` or `INACTIVE`.
     */
    public val status: aws.sdk.kotlin.services.kendra.model.FeaturedResultsSetStatus? = builder.status

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

    override fun toString(): kotlin.String = buildString {
        append("UpdateFeaturedResultsSetRequest(")
        append("description=$description,")
        append("featuredDocuments=$featuredDocuments,")
        append("featuredResultsSetId=$featuredResultsSetId,")
        append("featuredResultsSetName=$featuredResultsSetName,")
        append("indexId=$indexId,")
        append("queryTexts=$queryTexts,")
        append("status=$status")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = description?.hashCode() ?: 0
        result = 31 * result + (featuredDocuments?.hashCode() ?: 0)
        result = 31 * result + (featuredResultsSetId?.hashCode() ?: 0)
        result = 31 * result + (featuredResultsSetName?.hashCode() ?: 0)
        result = 31 * result + (indexId?.hashCode() ?: 0)
        result = 31 * result + (queryTexts?.hashCode() ?: 0)
        result = 31 * result + (status?.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 UpdateFeaturedResultsSetRequest

        if (description != other.description) return false
        if (featuredDocuments != other.featuredDocuments) return false
        if (featuredResultsSetId != other.featuredResultsSetId) return false
        if (featuredResultsSetName != other.featuredResultsSetName) return false
        if (indexId != other.indexId) return false
        if (queryTexts != other.queryTexts) return false
        if (status != other.status) return false

        return true
    }

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

    public class Builder {
        /**
         * A new description for the set of featured results.
         */
        public var description: kotlin.String? = null
        /**
         * A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
         */
        public var featuredDocuments: List? = null
        /**
         * The identifier of the set of featured results that you want to update.
         */
        public var featuredResultsSetId: kotlin.String? = null
        /**
         * A new name for the set of featured results.
         */
        public var featuredResultsSetName: kotlin.String? = null
        /**
         * The identifier of the index used for featuring results.
         */
        public var indexId: kotlin.String? = null
        /**
         * A list of queries for featuring results. For more information on the list of queries, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
         */
        public var queryTexts: List? = null
        /**
         * You can set the status to `ACTIVE` or `INACTIVE`. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. The queries you specify for featured results must be unique per featured results set for each index, whether the status is `ACTIVE` or `INACTIVE`.
         */
        public var status: aws.sdk.kotlin.services.kendra.model.FeaturedResultsSetStatus? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.kendra.model.UpdateFeaturedResultsSetRequest) : this() {
            this.description = x.description
            this.featuredDocuments = x.featuredDocuments
            this.featuredResultsSetId = x.featuredResultsSetId
            this.featuredResultsSetName = x.featuredResultsSetName
            this.indexId = x.indexId
            this.queryTexts = x.queryTexts
            this.status = x.status
        }

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

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