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

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

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



public class DescribeAccessControlConfigurationResponse private constructor(builder: Builder) {
    /**
     * Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
     */
    public val accessControlList: List? = builder.accessControlList
    /**
     * The description for the access control configuration.
     */
    public val description: kotlin.String? = builder.description
    /**
     * The error message containing details if there are issues processing the access control configuration.
     */
    public val errorMessage: kotlin.String? = builder.errorMessage
    /**
     * The list of [principal](https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that define the hierarchy for which documents users should have access to.
     */
    public val hierarchicalAccessControlList: List? = builder.hierarchicalAccessControlList
    /**
     * The name for the access control configuration.
     */
    public val name: kotlin.String = requireNotNull(builder.name) { "A non-null value must be provided for name" }

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

    override fun toString(): kotlin.String = buildString {
        append("DescribeAccessControlConfigurationResponse(")
        append("accessControlList=$accessControlList,")
        append("description=$description,")
        append("errorMessage=$errorMessage,")
        append("hierarchicalAccessControlList=$hierarchicalAccessControlList,")
        append("name=$name")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = accessControlList?.hashCode() ?: 0
        result = 31 * result + (description?.hashCode() ?: 0)
        result = 31 * result + (errorMessage?.hashCode() ?: 0)
        result = 31 * result + (hierarchicalAccessControlList?.hashCode() ?: 0)
        result = 31 * result + (name.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 DescribeAccessControlConfigurationResponse

        if (accessControlList != other.accessControlList) return false
        if (description != other.description) return false
        if (errorMessage != other.errorMessage) return false
        if (hierarchicalAccessControlList != other.hierarchicalAccessControlList) return false
        if (name != other.name) return false

        return true
    }

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

    public class Builder {
        /**
         * Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
         */
        public var accessControlList: List? = null
        /**
         * The description for the access control configuration.
         */
        public var description: kotlin.String? = null
        /**
         * The error message containing details if there are issues processing the access control configuration.
         */
        public var errorMessage: kotlin.String? = null
        /**
         * The list of [principal](https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html) lists that define the hierarchy for which documents users should have access to.
         */
        public var hierarchicalAccessControlList: List? = null
        /**
         * The name for the access control configuration.
         */
        public var name: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.kendra.model.DescribeAccessControlConfigurationResponse) : this() {
            this.accessControlList = x.accessControlList
            this.description = x.description
            this.errorMessage = x.errorMessage
            this.hierarchicalAccessControlList = x.hierarchicalAccessControlList
            this.name = x.name
        }

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

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