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

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

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



/**
 * Overrides the document relevance properties of a custom index field.
 */
public class DocumentRelevanceConfiguration private constructor(builder: Builder) {
    /**
     * The name of the index field.
     */
    public val name: kotlin.String = requireNotNull(builder.name) { "A non-null value must be provided for name" }
    /**
     * Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
     */
    public val relevance: aws.sdk.kotlin.services.kendra.model.Relevance? = builder.relevance

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

    override fun toString(): kotlin.String = buildString {
        append("DocumentRelevanceConfiguration(")
        append("name=$name,")
        append("relevance=$relevance")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = name.hashCode()
        result = 31 * result + (relevance?.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 DocumentRelevanceConfiguration

        if (name != other.name) return false
        if (relevance != other.relevance) return false

        return true
    }

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

    public class Builder {
        /**
         * The name of the index field.
         */
        public var name: kotlin.String? = null
        /**
         * Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
         */
        public var relevance: aws.sdk.kotlin.services.kendra.model.Relevance? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.kendra.model.DocumentRelevanceConfiguration) : this() {
            this.name = x.name
            this.relevance = x.relevance
        }

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

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

        internal fun correctErrors(): Builder {
            if (name == null) name = ""
            return this
        }
    }
}