commonMain.aws.sdk.kotlin.services.qbusiness.model.GetIndexResponse.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.qbusiness.model

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

public class GetIndexResponse private constructor(builder: Builder) {
    /**
     * The identifier of the Amazon Q Business application associated with the index.
     */
    public val applicationId: kotlin.String? = builder.applicationId
    /**
     * The storage capacity units chosen for your Amazon Q Business index.
     */
    public val capacityConfiguration: aws.sdk.kotlin.services.qbusiness.model.IndexCapacityConfiguration? = builder.capacityConfiguration
    /**
     * The Unix timestamp when the Amazon Q Business index was created.
     */
    public val createdAt: aws.smithy.kotlin.runtime.time.Instant? = builder.createdAt
    /**
     * The description for the Amazon Q Business index.
     */
    public val description: kotlin.String? = builder.description
    /**
     * The name of the Amazon Q Business index.
     */
    public val displayName: kotlin.String? = builder.displayName
    /**
     * Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see [Understanding document attributes](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes).
     */
    public val documentAttributeConfigurations: List? = builder.documentAttributeConfigurations
    /**
     * When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
     */
    public val error: aws.sdk.kotlin.services.qbusiness.model.ErrorDetail? = builder.error
    /**
     * The Amazon Resource Name (ARN) of the Amazon Q Business index.
     */
    public val indexArn: kotlin.String? = builder.indexArn
    /**
     * The identifier of the Amazon Q Business index.
     */
    public val indexId: kotlin.String? = builder.indexId
    /**
     * Provides information about the number of documents indexed.
     */
    public val indexStatistics: aws.sdk.kotlin.services.qbusiness.model.IndexStatistics? = builder.indexStatistics
    /**
     * The current status of the index. When the value is `ACTIVE`, the index is ready for use. If the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
     */
    public val status: aws.sdk.kotlin.services.qbusiness.model.IndexStatus? = builder.status
    /**
     * The Unix timestamp when the Amazon Q Business index 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.qbusiness.model.GetIndexResponse = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("GetIndexResponse(")
        append("applicationId=$applicationId,")
        append("capacityConfiguration=$capacityConfiguration,")
        append("createdAt=$createdAt,")
        append("description=$description,")
        append("displayName=$displayName,")
        append("documentAttributeConfigurations=$documentAttributeConfigurations,")
        append("error=$error,")
        append("indexArn=$indexArn,")
        append("indexId=$indexId,")
        append("indexStatistics=$indexStatistics,")
        append("status=$status,")
        append("updatedAt=$updatedAt")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = applicationId?.hashCode() ?: 0
        result = 31 * result + (capacityConfiguration?.hashCode() ?: 0)
        result = 31 * result + (createdAt?.hashCode() ?: 0)
        result = 31 * result + (description?.hashCode() ?: 0)
        result = 31 * result + (displayName?.hashCode() ?: 0)
        result = 31 * result + (documentAttributeConfigurations?.hashCode() ?: 0)
        result = 31 * result + (error?.hashCode() ?: 0)
        result = 31 * result + (indexArn?.hashCode() ?: 0)
        result = 31 * result + (indexId?.hashCode() ?: 0)
        result = 31 * result + (indexStatistics?.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 GetIndexResponse

        if (applicationId != other.applicationId) return false
        if (capacityConfiguration != other.capacityConfiguration) return false
        if (createdAt != other.createdAt) return false
        if (description != other.description) return false
        if (displayName != other.displayName) return false
        if (documentAttributeConfigurations != other.documentAttributeConfigurations) return false
        if (error != other.error) return false
        if (indexArn != other.indexArn) return false
        if (indexId != other.indexId) return false
        if (indexStatistics != other.indexStatistics) 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.qbusiness.model.GetIndexResponse = Builder(this).apply(block).build()

    public class Builder {
        /**
         * The identifier of the Amazon Q Business application associated with the index.
         */
        public var applicationId: kotlin.String? = null
        /**
         * The storage capacity units chosen for your Amazon Q Business index.
         */
        public var capacityConfiguration: aws.sdk.kotlin.services.qbusiness.model.IndexCapacityConfiguration? = null
        /**
         * The Unix timestamp when the Amazon Q Business index was created.
         */
        public var createdAt: aws.smithy.kotlin.runtime.time.Instant? = null
        /**
         * The description for the Amazon Q Business index.
         */
        public var description: kotlin.String? = null
        /**
         * The name of the Amazon Q Business index.
         */
        public var displayName: kotlin.String? = null
        /**
         * Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see [Understanding document attributes](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes).
         */
        public var documentAttributeConfigurations: List? = null
        /**
         * When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
         */
        public var error: aws.sdk.kotlin.services.qbusiness.model.ErrorDetail? = null
        /**
         * The Amazon Resource Name (ARN) of the Amazon Q Business index.
         */
        public var indexArn: kotlin.String? = null
        /**
         * The identifier of the Amazon Q Business index.
         */
        public var indexId: kotlin.String? = null
        /**
         * Provides information about the number of documents indexed.
         */
        public var indexStatistics: aws.sdk.kotlin.services.qbusiness.model.IndexStatistics? = null
        /**
         * The current status of the index. When the value is `ACTIVE`, the index is ready for use. If the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
         */
        public var status: aws.sdk.kotlin.services.qbusiness.model.IndexStatus? = null
        /**
         * The Unix timestamp when the Amazon Q Business index was last updated.
         */
        public var updatedAt: aws.smithy.kotlin.runtime.time.Instant? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.qbusiness.model.GetIndexResponse) : this() {
            this.applicationId = x.applicationId
            this.capacityConfiguration = x.capacityConfiguration
            this.createdAt = x.createdAt
            this.description = x.description
            this.displayName = x.displayName
            this.documentAttributeConfigurations = x.documentAttributeConfigurations
            this.error = x.error
            this.indexArn = x.indexArn
            this.indexId = x.indexId
            this.indexStatistics = x.indexStatistics
            this.status = x.status
            this.updatedAt = x.updatedAt
        }

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

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

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

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

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