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

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

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



/**
 * A list of users or sub groups that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
 */
public class GroupMembers private constructor(builder: Builder) {
    /**
     * A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".
     */
    public val memberGroups: List? = builder.memberGroups
    /**
     * A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
     */
    public val memberUsers: List? = builder.memberUsers
    /**
     * If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
     *
     * You can download this [example S3 file](https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip) that uses the correct format for listing group members. Note, `dataSourceId` is optional. The value of `type` for a group is always `GROUP` and for a user it is always `USER`.
     */
    public val s3PathforGroupMembers: aws.sdk.kotlin.services.kendra.model.S3Path? = builder.s3PathforGroupMembers

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

    override fun toString(): kotlin.String = buildString {
        append("GroupMembers(")
        append("memberGroups=$memberGroups,")
        append("memberUsers=$memberUsers,")
        append("s3PathforGroupMembers=$s3PathforGroupMembers")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = memberGroups?.hashCode() ?: 0
        result = 31 * result + (memberUsers?.hashCode() ?: 0)
        result = 31 * result + (s3PathforGroupMembers?.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 GroupMembers

        if (memberGroups != other.memberGroups) return false
        if (memberUsers != other.memberUsers) return false
        if (s3PathforGroupMembers != other.s3PathforGroupMembers) return false

        return true
    }

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

    public class Builder {
        /**
         * A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".
         */
        public var memberGroups: List? = null
        /**
         * A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
         */
        public var memberUsers: List? = null
        /**
         * If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
         *
         * You can download this [example S3 file](https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip) that uses the correct format for listing group members. Note, `dataSourceId` is optional. The value of `type` for a group is always `GROUP` and for a user it is always `USER`.
         */
        public var s3PathforGroupMembers: aws.sdk.kotlin.services.kendra.model.S3Path? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.kendra.model.GroupMembers) : this() {
            this.memberGroups = x.memberGroups
            this.memberUsers = x.memberUsers
            this.s3PathforGroupMembers = x.s3PathforGroupMembers
        }

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

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

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