commonMain.aws.sdk.kotlin.services.finspacedata.model.UserByPermissionGroup.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of finspacedata-jvm Show documentation
The AWS SDK for Kotlin client for finspace data
There is a newer version: 1.3.99
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.finspacedata.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * The structure of a user associated with a permission group.
 */
public class UserByPermissionGroup private constructor(builder: Builder) {
    /**
     * Indicates whether the user can access FinSpace API operations.
     * + `ENABLED` – The user has permissions to use the API operations.
     * + `DISABLED` – The user does not have permissions to use any API operations.
     */
    public val apiAccess: aws.sdk.kotlin.services.finspacedata.model.ApiAccess? = builder.apiAccess
    /**
     * The IAM ARN identifier that is attached to FinSpace API calls.
     */
    public val apiAccessPrincipalArn: kotlin.String? = builder.apiAccessPrincipalArn
    /**
     * The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.
     */
    public val emailAddress: kotlin.String? = builder.emailAddress
    /**
     * The first name of the user.
     */
    public val firstName: kotlin.String? = builder.firstName
    /**
     * The last name of the user.
     */
    public val lastName: kotlin.String? = builder.lastName
    /**
     * Indicates the status of the user within a permission group.
     * + `ADDITION_IN_PROGRESS` – The user is currently being added to the permission group.
     * + `ADDITION_SUCCESS` – The user is successfully added to the permission group.
     * + `REMOVAL_IN_PROGRESS` – The user is currently being removed from the permission group.
     */
    public val membershipStatus: aws.sdk.kotlin.services.finspacedata.model.PermissionGroupMembershipStatus? = builder.membershipStatus
    /**
     * The current status of the user.
     * + `CREATING` – The user creation is in progress.
     * + `ENABLED` – The user is created and is currently active.
     * + `DISABLED` – The user is currently inactive.
     */
    public val status: aws.sdk.kotlin.services.finspacedata.model.UserStatus? = builder.status
    /**
     * Indicates the type of user.
     * + `SUPER_USER` – A user with permission to all the functionality and data in FinSpace.
     * + `APP_USER` – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
     */
    public val type: aws.sdk.kotlin.services.finspacedata.model.UserType? = builder.type
    /**
     * The unique identifier for the user.
     */
    public val userId: kotlin.String? = builder.userId

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

    override fun toString(): kotlin.String = buildString {
        append("UserByPermissionGroup(")
        append("apiAccess=$apiAccess,")
        append("apiAccessPrincipalArn=$apiAccessPrincipalArn,")
        append("emailAddress=*** Sensitive Data Redacted ***,")
        append("firstName=*** Sensitive Data Redacted ***,")
        append("lastName=*** Sensitive Data Redacted ***,")
        append("membershipStatus=$membershipStatus,")
        append("status=$status,")
        append("type=$type,")
        append("userId=$userId")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = apiAccess?.hashCode() ?: 0
        result = 31 * result + (apiAccessPrincipalArn?.hashCode() ?: 0)
        result = 31 * result + (emailAddress?.hashCode() ?: 0)
        result = 31 * result + (firstName?.hashCode() ?: 0)
        result = 31 * result + (lastName?.hashCode() ?: 0)
        result = 31 * result + (membershipStatus?.hashCode() ?: 0)
        result = 31 * result + (status?.hashCode() ?: 0)
        result = 31 * result + (type?.hashCode() ?: 0)
        result = 31 * result + (userId?.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 UserByPermissionGroup

        if (apiAccess != other.apiAccess) return false
        if (apiAccessPrincipalArn != other.apiAccessPrincipalArn) return false
        if (emailAddress != other.emailAddress) return false
        if (firstName != other.firstName) return false
        if (lastName != other.lastName) return false
        if (membershipStatus != other.membershipStatus) return false
        if (status != other.status) return false
        if (type != other.type) return false
        if (userId != other.userId) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Indicates whether the user can access FinSpace API operations.
         * + `ENABLED` – The user has permissions to use the API operations.
         * + `DISABLED` – The user does not have permissions to use any API operations.
         */
        public var apiAccess: aws.sdk.kotlin.services.finspacedata.model.ApiAccess? = null
        /**
         * The IAM ARN identifier that is attached to FinSpace API calls.
         */
        public var apiAccessPrincipalArn: kotlin.String? = null
        /**
         * The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.
         */
        public var emailAddress: kotlin.String? = null
        /**
         * The first name of the user.
         */
        public var firstName: kotlin.String? = null
        /**
         * The last name of the user.
         */
        public var lastName: kotlin.String? = null
        /**
         * Indicates the status of the user within a permission group.
         * + `ADDITION_IN_PROGRESS` – The user is currently being added to the permission group.
         * + `ADDITION_SUCCESS` – The user is successfully added to the permission group.
         * + `REMOVAL_IN_PROGRESS` – The user is currently being removed from the permission group.
         */
        public var membershipStatus: aws.sdk.kotlin.services.finspacedata.model.PermissionGroupMembershipStatus? = null
        /**
         * The current status of the user.
         * + `CREATING` – The user creation is in progress.
         * + `ENABLED` – The user is created and is currently active.
         * + `DISABLED` – The user is currently inactive.
         */
        public var status: aws.sdk.kotlin.services.finspacedata.model.UserStatus? = null
        /**
         * Indicates the type of user.
         * + `SUPER_USER` – A user with permission to all the functionality and data in FinSpace.
         * + `APP_USER` – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
         */
        public var type: aws.sdk.kotlin.services.finspacedata.model.UserType? = null
        /**
         * The unique identifier for the user.
         */
        public var userId: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.finspacedata.model.UserByPermissionGroup) : this() {
            this.apiAccess = x.apiAccess
            this.apiAccessPrincipalArn = x.apiAccessPrincipalArn
            this.emailAddress = x.emailAddress
            this.firstName = x.firstName
            this.lastName = x.lastName
            this.membershipStatus = x.membershipStatus
            this.status = x.status
            this.type = x.type
            this.userId = x.userId
        }

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

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