All Downloads are FREE. Search and download functionalities are using the official Maven repository.

commonMain.aws.sdk.kotlin.services.qapps.model.QQueryCardInput.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.qapps.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * The input shape for defining a query card in an Amazon Q App.
 */
public class QQueryCardInput private constructor(builder: Builder) {
    /**
     * Turns on filtering of responses based on document attributes or metadata fields.
     */
    public val attributeFilter: aws.sdk.kotlin.services.qapps.model.AttributeFilter? = builder.attributeFilter
    /**
     * The unique identifier of the query card.
     */
    public val id: kotlin.String = requireNotNull(builder.id) { "A non-null value must be provided for id" }
    /**
     * The source or type of output to generate for the query card.
     */
    public val outputSource: aws.sdk.kotlin.services.qapps.model.CardOutputSource = builder.outputSource
    /**
     * The prompt or instructions displayed for the query card.
     */
    public val prompt: kotlin.String = requireNotNull(builder.prompt) { "A non-null value must be provided for prompt" }
    /**
     * The title or label of the query card.
     */
    public val title: kotlin.String = requireNotNull(builder.title) { "A non-null value must be provided for title" }
    /**
     * The type of the card.
     */
    public val type: aws.sdk.kotlin.services.qapps.model.CardType = builder.type

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

    override fun toString(): kotlin.String = buildString {
        append("QQueryCardInput(")
        append("attributeFilter=$attributeFilter,")
        append("id=$id,")
        append("outputSource=$outputSource,")
        append("prompt=$prompt,")
        append("title=$title,")
        append("type=$type")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = attributeFilter?.hashCode() ?: 0
        result = 31 * result + (id.hashCode())
        result = 31 * result + (outputSource.hashCode())
        result = 31 * result + (prompt.hashCode())
        result = 31 * result + (title.hashCode())
        result = 31 * result + (type.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 QQueryCardInput

        if (attributeFilter != other.attributeFilter) return false
        if (id != other.id) return false
        if (outputSource != other.outputSource) return false
        if (prompt != other.prompt) return false
        if (title != other.title) return false
        if (type != other.type) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Turns on filtering of responses based on document attributes or metadata fields.
         */
        public var attributeFilter: aws.sdk.kotlin.services.qapps.model.AttributeFilter? = null
        /**
         * The unique identifier of the query card.
         */
        public var id: kotlin.String? = null
        /**
         * The source or type of output to generate for the query card.
         */
        public var outputSource: aws.sdk.kotlin.services.qapps.model.CardOutputSource = aws.sdk.kotlin.services.qapps.model.CardOutputSource.fromValue("approved-sources")
        /**
         * The prompt or instructions displayed for the query card.
         */
        public var prompt: kotlin.String? = null
        /**
         * The title or label of the query card.
         */
        public var title: kotlin.String? = null
        /**
         * The type of the card.
         */
        public var type: aws.sdk.kotlin.services.qapps.model.CardType = aws.sdk.kotlin.services.qapps.model.CardType.fromValue("q-query")

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.qapps.model.QQueryCardInput) : this() {
            this.attributeFilter = x.attributeFilter
            this.id = x.id
            this.outputSource = x.outputSource
            this.prompt = x.prompt
            this.title = x.title
            this.type = x.type
        }

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

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

        internal fun correctErrors(): Builder {
            if (id == null) id = ""
            if (prompt == null) prompt = ""
            if (title == null) title = ""
            return this
        }
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy