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

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

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



/**
 * Provides feedback on how relevant a document is to a search. Your application uses the `SubmitFeedback` API to provide relevance information.
 */
public class RelevanceFeedback private constructor(builder: Builder) {
    /**
     * Whether the document was relevant or not relevant to the search.
     */
    public val relevanceValue: aws.sdk.kotlin.services.kendra.model.RelevanceType = requireNotNull(builder.relevanceValue) { "A non-null value must be provided for relevanceValue" }
    /**
     * The identifier of the search result that the user provided relevance feedback for.
     */
    public val resultId: kotlin.String = requireNotNull(builder.resultId) { "A non-null value must be provided for resultId" }

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

    override fun toString(): kotlin.String = buildString {
        append("RelevanceFeedback(")
        append("relevanceValue=$relevanceValue,")
        append("resultId=$resultId")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = relevanceValue.hashCode()
        result = 31 * result + (resultId.hashCode())
        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 RelevanceFeedback

        if (relevanceValue != other.relevanceValue) return false
        if (resultId != other.resultId) return false

        return true
    }

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

    public class Builder {
        /**
         * Whether the document was relevant or not relevant to the search.
         */
        public var relevanceValue: aws.sdk.kotlin.services.kendra.model.RelevanceType? = null
        /**
         * The identifier of the search result that the user provided relevance feedback for.
         */
        public var resultId: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.kendra.model.RelevanceFeedback) : this() {
            this.relevanceValue = x.relevanceValue
            this.resultId = x.resultId
        }

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

        internal fun correctErrors(): Builder {
            if (relevanceValue == null) relevanceValue = RelevanceType.SdkUnknown("no value provided")
            if (resultId == null) resultId = ""
            return this
        }
    }
}