commonMain.aws.sdk.kotlin.services.kendra.model.DescribeFeaturedResultsSetResponse.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 DescribeFeaturedResultsSetResponse private constructor(builder: Builder) {
    /**
     * The Unix timestamp when the set of the featured results was created.
     */
    public val creationTimestamp: kotlin.Long? = builder.creationTimestamp
    /**
     * The description for the set of featured results.
     */
    public val description: kotlin.String? = builder.description
    /**
     * The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the [BatchGetDocumentStatus](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) API.
     */
    public val featuredDocumentsMissing: List? = builder.featuredDocumentsMissing
    /**
     * The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
     */
    public val featuredDocumentsWithMetadata: List? = builder.featuredDocumentsWithMetadata
    /**
     * The identifier of the set of featured results.
     */
    public val featuredResultsSetId: kotlin.String? = builder.featuredResultsSetId
    /**
     * The name for the set of featured results.
     */
    public val featuredResultsSetName: kotlin.String? = builder.featuredResultsSetName
    /**
     * The timestamp when the set of featured results was last updated.
     */
    public val lastUpdatedTimestamp: kotlin.Long? = builder.lastUpdatedTimestamp
    /**
     * The 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
    /**
     * The current status of the set of featured results. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. You can set the status to `ACTIVE` or `INACTIVE` using the [UpdateFeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) API. 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.DescribeFeaturedResultsSetResponse = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("DescribeFeaturedResultsSetResponse(")
        append("creationTimestamp=$creationTimestamp,")
        append("description=$description,")
        append("featuredDocumentsMissing=$featuredDocumentsMissing,")
        append("featuredDocumentsWithMetadata=$featuredDocumentsWithMetadata,")
        append("featuredResultsSetId=$featuredResultsSetId,")
        append("featuredResultsSetName=$featuredResultsSetName,")
        append("lastUpdatedTimestamp=$lastUpdatedTimestamp,")
        append("queryTexts=$queryTexts,")
        append("status=$status")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = creationTimestamp?.hashCode() ?: 0
        result = 31 * result + (description?.hashCode() ?: 0)
        result = 31 * result + (featuredDocumentsMissing?.hashCode() ?: 0)
        result = 31 * result + (featuredDocumentsWithMetadata?.hashCode() ?: 0)
        result = 31 * result + (featuredResultsSetId?.hashCode() ?: 0)
        result = 31 * result + (featuredResultsSetName?.hashCode() ?: 0)
        result = 31 * result + (lastUpdatedTimestamp?.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 DescribeFeaturedResultsSetResponse

        if (creationTimestamp != other.creationTimestamp) return false
        if (description != other.description) return false
        if (featuredDocumentsMissing != other.featuredDocumentsMissing) return false
        if (featuredDocumentsWithMetadata != other.featuredDocumentsWithMetadata) return false
        if (featuredResultsSetId != other.featuredResultsSetId) return false
        if (featuredResultsSetName != other.featuredResultsSetName) return false
        if (lastUpdatedTimestamp != other.lastUpdatedTimestamp) 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.DescribeFeaturedResultsSetResponse = Builder(this).apply(block).build()

    public class Builder {
        /**
         * The Unix timestamp when the set of the featured results was created.
         */
        public var creationTimestamp: kotlin.Long? = null
        /**
         * The description for the set of featured results.
         */
        public var description: kotlin.String? = null
        /**
         * The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the [BatchGetDocumentStatus](https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html) API.
         */
        public var featuredDocumentsMissing: List? = null
        /**
         * The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see [FeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html).
         */
        public var featuredDocumentsWithMetadata: List? = null
        /**
         * The identifier of the set of featured results.
         */
        public var featuredResultsSetId: kotlin.String? = null
        /**
         * The name for the set of featured results.
         */
        public var featuredResultsSetName: kotlin.String? = null
        /**
         * The timestamp when the set of featured results was last updated.
         */
        public var lastUpdatedTimestamp: kotlin.Long? = null
        /**
         * The 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
        /**
         * The current status of the set of featured results. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. You can set the status to `ACTIVE` or `INACTIVE` using the [UpdateFeaturedResultsSet](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html) API. 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.DescribeFeaturedResultsSetResponse) : this() {
            this.creationTimestamp = x.creationTimestamp
            this.description = x.description
            this.featuredDocumentsMissing = x.featuredDocumentsMissing
            this.featuredDocumentsWithMetadata = x.featuredDocumentsWithMetadata
            this.featuredResultsSetId = x.featuredResultsSetId
            this.featuredResultsSetName = x.featuredResultsSetName
            this.lastUpdatedTimestamp = x.lastUpdatedTimestamp
            this.queryTexts = x.queryTexts
            this.status = x.status
        }

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

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