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

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

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

import aws.smithy.kotlin.runtime.time.Instant

public class DescribeFaqResponse private constructor(builder: Builder) {
    /**
     * The Unix timestamp when the FAQ was created.
     */
    public val createdAt: aws.smithy.kotlin.runtime.time.Instant? = builder.createdAt
    /**
     * The description of the FAQ that you provided when it was created.
     */
    public val description: kotlin.String? = builder.description
    /**
     * If the `Status` field is `FAILED`, the `ErrorMessage` field contains the reason why the FAQ failed.
     */
    public val errorMessage: kotlin.String? = builder.errorMessage
    /**
     * The file format used by the input files for the FAQ.
     */
    public val fileFormat: aws.sdk.kotlin.services.kendra.model.FaqFileFormat? = builder.fileFormat
    /**
     * The identifier of the FAQ.
     */
    public val id: kotlin.String? = builder.id
    /**
     * The identifier of the index for the FAQ.
     */
    public val indexId: kotlin.String? = builder.indexId
    /**
     * The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
     */
    public val languageCode: kotlin.String? = builder.languageCode
    /**
     * The name that you gave the FAQ when it was created.
     */
    public val name: kotlin.String? = builder.name
    /**
     * The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
     */
    public val roleArn: kotlin.String? = builder.roleArn
    /**
     * Information required to find a specific file in an Amazon S3 bucket.
     */
    public val s3Path: aws.sdk.kotlin.services.kendra.model.S3Path? = builder.s3Path
    /**
     * The status of the FAQ. It is ready to use when the status is `ACTIVE`.
     */
    public val status: aws.sdk.kotlin.services.kendra.model.FaqStatus? = builder.status
    /**
     * The Unix timestamp when the FAQ was last updated.
     */
    public val updatedAt: aws.smithy.kotlin.runtime.time.Instant? = builder.updatedAt

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

    override fun toString(): kotlin.String = buildString {
        append("DescribeFaqResponse(")
        append("createdAt=$createdAt,")
        append("description=$description,")
        append("errorMessage=$errorMessage,")
        append("fileFormat=$fileFormat,")
        append("id=$id,")
        append("indexId=$indexId,")
        append("languageCode=$languageCode,")
        append("name=$name,")
        append("roleArn=$roleArn,")
        append("s3Path=$s3Path,")
        append("status=$status,")
        append("updatedAt=$updatedAt")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = createdAt?.hashCode() ?: 0
        result = 31 * result + (description?.hashCode() ?: 0)
        result = 31 * result + (errorMessage?.hashCode() ?: 0)
        result = 31 * result + (fileFormat?.hashCode() ?: 0)
        result = 31 * result + (id?.hashCode() ?: 0)
        result = 31 * result + (indexId?.hashCode() ?: 0)
        result = 31 * result + (languageCode?.hashCode() ?: 0)
        result = 31 * result + (name?.hashCode() ?: 0)
        result = 31 * result + (roleArn?.hashCode() ?: 0)
        result = 31 * result + (s3Path?.hashCode() ?: 0)
        result = 31 * result + (status?.hashCode() ?: 0)
        result = 31 * result + (updatedAt?.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 DescribeFaqResponse

        if (createdAt != other.createdAt) return false
        if (description != other.description) return false
        if (errorMessage != other.errorMessage) return false
        if (fileFormat != other.fileFormat) return false
        if (id != other.id) return false
        if (indexId != other.indexId) return false
        if (languageCode != other.languageCode) return false
        if (name != other.name) return false
        if (roleArn != other.roleArn) return false
        if (s3Path != other.s3Path) return false
        if (status != other.status) return false
        if (updatedAt != other.updatedAt) return false

        return true
    }

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

    public class Builder {
        /**
         * The Unix timestamp when the FAQ was created.
         */
        public var createdAt: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The description of the FAQ that you provided when it was created.
         */
        public var description: kotlin.String? = null
        /**
         * If the `Status` field is `FAILED`, the `ErrorMessage` field contains the reason why the FAQ failed.
         */
        public var errorMessage: kotlin.String? = null
        /**
         * The file format used by the input files for the FAQ.
         */
        public var fileFormat: aws.sdk.kotlin.services.kendra.model.FaqFileFormat? = null
        /**
         * The identifier of the FAQ.
         */
        public var id: kotlin.String? = null
        /**
         * The identifier of the index for the FAQ.
         */
        public var indexId: kotlin.String? = null
        /**
         * The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).
         */
        public var languageCode: kotlin.String? = null
        /**
         * The name that you gave the FAQ when it was created.
         */
        public var name: kotlin.String? = null
        /**
         * The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
         */
        public var roleArn: kotlin.String? = null
        /**
         * Information required to find a specific file in an Amazon S3 bucket.
         */
        public var s3Path: aws.sdk.kotlin.services.kendra.model.S3Path? = null
        /**
         * The status of the FAQ. It is ready to use when the status is `ACTIVE`.
         */
        public var status: aws.sdk.kotlin.services.kendra.model.FaqStatus? = null
        /**
         * The Unix timestamp when the FAQ was last updated.
         */
        public var updatedAt: aws.smithy.kotlin.runtime.time.Instant? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.kendra.model.DescribeFaqResponse) : this() {
            this.createdAt = x.createdAt
            this.description = x.description
            this.errorMessage = x.errorMessage
            this.fileFormat = x.fileFormat
            this.id = x.id
            this.indexId = x.indexId
            this.languageCode = x.languageCode
            this.name = x.name
            this.roleArn = x.roleArn
            this.s3Path = x.s3Path
            this.status = x.status
            this.updatedAt = x.updatedAt
        }

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

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

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