commonMain.aws.sdk.kotlin.services.finspacedata.model.PermissionGroup.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 for a permission group.
 */
public class PermissionGroup private constructor(builder: Builder) {
    /**
     * Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
     *
     * When assigning application permissions, be aware that the permission `ManageUsersAndGroups` allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
     *
     * + `CreateDataset` – Group members can create new datasets.
     * + `ManageClusters` – Group members can manage Apache Spark clusters from FinSpace notebooks.
     * + `ManageUsersAndGroups` – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
     * + `ManageAttributeSets` – Group members can manage attribute sets.
     * + `ViewAuditData` – Group members can view audit data.
     * + `AccessNotebooks` – Group members will have access to FinSpace notebooks.
     * + `GetTemporaryCredentials` – Group members can get temporary API credentials.
     */
    public val applicationPermissions: List? = builder.applicationPermissions
    /**
     * The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
     */
    public val createTime: kotlin.Long = builder.createTime
    /**
     * A brief description for the permission group.
     */
    public val description: kotlin.String? = builder.description
    /**
     * Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
     */
    public val lastModifiedTime: kotlin.Long = builder.lastModifiedTime
    /**
     * 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 name of the permission group.
     */
    public val name: kotlin.String? = builder.name
    /**
     * The unique identifier for the permission group.
     */
    public val permissionGroupId: kotlin.String? = builder.permissionGroupId

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

    override fun toString(): kotlin.String = buildString {
        append("PermissionGroup(")
        append("applicationPermissions=$applicationPermissions,")
        append("createTime=$createTime,")
        append("description=*** Sensitive Data Redacted ***,")
        append("lastModifiedTime=$lastModifiedTime,")
        append("membershipStatus=$membershipStatus,")
        append("name=*** Sensitive Data Redacted ***,")
        append("permissionGroupId=$permissionGroupId")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = applicationPermissions?.hashCode() ?: 0
        result = 31 * result + (createTime.hashCode())
        result = 31 * result + (description?.hashCode() ?: 0)
        result = 31 * result + (lastModifiedTime.hashCode())
        result = 31 * result + (membershipStatus?.hashCode() ?: 0)
        result = 31 * result + (name?.hashCode() ?: 0)
        result = 31 * result + (permissionGroupId?.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 PermissionGroup

        if (applicationPermissions != other.applicationPermissions) return false
        if (createTime != other.createTime) return false
        if (description != other.description) return false
        if (lastModifiedTime != other.lastModifiedTime) return false
        if (membershipStatus != other.membershipStatus) return false
        if (name != other.name) return false
        if (permissionGroupId != other.permissionGroupId) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
         *
         * When assigning application permissions, be aware that the permission `ManageUsersAndGroups` allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.
         *
         * + `CreateDataset` – Group members can create new datasets.
         * + `ManageClusters` – Group members can manage Apache Spark clusters from FinSpace notebooks.
         * + `ManageUsersAndGroups` – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.
         * + `ManageAttributeSets` – Group members can manage attribute sets.
         * + `ViewAuditData` – Group members can view audit data.
         * + `AccessNotebooks` – Group members will have access to FinSpace notebooks.
         * + `GetTemporaryCredentials` – Group members can get temporary API credentials.
         */
        public var applicationPermissions: List? = null
        /**
         * The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
         */
        public var createTime: kotlin.Long = 0L
        /**
         * A brief description for the permission group.
         */
        public var description: kotlin.String? = null
        /**
         * Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
         */
        public var lastModifiedTime: kotlin.Long = 0L
        /**
         * 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 name of the permission group.
         */
        public var name: kotlin.String? = null
        /**
         * The unique identifier for the permission group.
         */
        public var permissionGroupId: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.finspacedata.model.PermissionGroup) : this() {
            this.applicationPermissions = x.applicationPermissions
            this.createTime = x.createTime
            this.description = x.description
            this.lastModifiedTime = x.lastModifiedTime
            this.membershipStatus = x.membershipStatus
            this.name = x.name
            this.permissionGroupId = x.permissionGroupId
        }

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

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