commonMain.aws.sdk.kotlin.services.finspace.model.UpdateEnvironmentRequest.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.finspace.model



public class UpdateEnvironmentRequest private constructor(builder: Builder) {
    /**
     * The description of the environment.
     */
    public val description: kotlin.String? = builder.description
    /**
     * The identifier of the FinSpace environment.
     */
    public val environmentId: kotlin.String? = requireNotNull(builder.environmentId) { "A non-null value must be provided for environmentId" }
    /**
     * Authentication mode for the environment.
     * + `FEDERATED` - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
     * + `LOCAL` - Users access FinSpace via email and password managed within the FinSpace environment.
     */
    public val federationMode: aws.sdk.kotlin.services.finspace.model.FederationMode? = builder.federationMode
    /**
     * Configuration information when authentication mode is FEDERATED.
     */
    public val federationParameters: aws.sdk.kotlin.services.finspace.model.FederationParameters? = builder.federationParameters
    /**
     * The name of the environment.
     */
    public val name: kotlin.String? = builder.name

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

    override fun toString(): kotlin.String = buildString {
        append("UpdateEnvironmentRequest(")
        append("description=$description,")
        append("environmentId=$environmentId,")
        append("federationMode=$federationMode,")
        append("federationParameters=$federationParameters,")
        append("name=$name")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = description?.hashCode() ?: 0
        result = 31 * result + (environmentId?.hashCode() ?: 0)
        result = 31 * result + (federationMode?.hashCode() ?: 0)
        result = 31 * result + (federationParameters?.hashCode() ?: 0)
        result = 31 * result + (name?.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 UpdateEnvironmentRequest

        if (description != other.description) return false
        if (environmentId != other.environmentId) return false
        if (federationMode != other.federationMode) return false
        if (federationParameters != other.federationParameters) return false
        if (name != other.name) return false

        return true
    }

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

    public class Builder {
        /**
         * The description of the environment.
         */
        public var description: kotlin.String? = null
        /**
         * The identifier of the FinSpace environment.
         */
        public var environmentId: kotlin.String? = null
        /**
         * Authentication mode for the environment.
         * + `FEDERATED` - Users access FinSpace through Single Sign On (SSO) via your Identity provider.
         * + `LOCAL` - Users access FinSpace via email and password managed within the FinSpace environment.
         */
        public var federationMode: aws.sdk.kotlin.services.finspace.model.FederationMode? = null
        /**
         * Configuration information when authentication mode is FEDERATED.
         */
        public var federationParameters: aws.sdk.kotlin.services.finspace.model.FederationParameters? = null
        /**
         * The name of the environment.
         */
        public var name: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.finspace.model.UpdateEnvironmentRequest) : this() {
            this.description = x.description
            this.environmentId = x.environmentId
            this.federationMode = x.federationMode
            this.federationParameters = x.federationParameters
            this.name = x.name
        }

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

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