commonMain.aws.sdk.kotlin.services.quicksight.model.GetDashboardEmbedUrlRequest.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.quicksight.model



class GetDashboardEmbedUrlRequest private constructor(builder: Builder) {
    /**
     * A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The `IdentityType` parameter must be set to `ANONYMOUS` for this to work, because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS`", the session can access all three dashboards.
     */
    val additionalDashboardIds: List? = builder.additionalDashboardIds
    /**
     * The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
     */
    val awsAccountId: kotlin.String? = builder.awsAccountId
    /**
     * The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
     */
    val dashboardId: kotlin.String? = builder.dashboardId
    /**
     * The authentication method that the user uses to sign in.
     */
    val identityType: aws.sdk.kotlin.services.quicksight.model.EmbeddingIdentityType? = builder.identityType
    /**
     * The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set `Namespace = default`.
     */
    val namespace: kotlin.String? = builder.namespace
    /**
     * Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
     */
    val resetDisabled: kotlin.Boolean = builder.resetDisabled
    /**
     * How many minutes the session is valid. The session lifetime must be 15-600 minutes.
     */
    val sessionLifetimeInMinutes: kotlin.Long? = builder.sessionLifetimeInMinutes
    /**
     * Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to `TRUE`, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is `FALSE`.
     */
    val statePersistenceEnabled: kotlin.Boolean = builder.statePersistenceEnabled
    /**
     * Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
     */
    val undoRedoDisabled: kotlin.Boolean = builder.undoRedoDisabled
    /**
     * The Amazon QuickSight user's Amazon Resource Name (ARN), for use with `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
     * + Active Directory (AD) users or group members
     * + Invited nonfederated users
     * + IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
     *
     * Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
     */
    val userArn: kotlin.String? = builder.userArn

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

    override fun toString(): kotlin.String = buildString {
        append("GetDashboardEmbedUrlRequest(")
        append("additionalDashboardIds=$additionalDashboardIds,")
        append("awsAccountId=$awsAccountId,")
        append("dashboardId=$dashboardId,")
        append("identityType=$identityType,")
        append("namespace=$namespace,")
        append("resetDisabled=$resetDisabled,")
        append("sessionLifetimeInMinutes=$sessionLifetimeInMinutes,")
        append("statePersistenceEnabled=$statePersistenceEnabled,")
        append("undoRedoDisabled=$undoRedoDisabled,")
        append("userArn=$userArn)")
    }

    override fun hashCode(): kotlin.Int {
        var result = additionalDashboardIds?.hashCode() ?: 0
        result = 31 * result + (awsAccountId?.hashCode() ?: 0)
        result = 31 * result + (dashboardId?.hashCode() ?: 0)
        result = 31 * result + (identityType?.hashCode() ?: 0)
        result = 31 * result + (namespace?.hashCode() ?: 0)
        result = 31 * result + (resetDisabled.hashCode())
        result = 31 * result + (sessionLifetimeInMinutes?.hashCode() ?: 0)
        result = 31 * result + (statePersistenceEnabled.hashCode())
        result = 31 * result + (undoRedoDisabled.hashCode())
        result = 31 * result + (userArn?.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 GetDashboardEmbedUrlRequest

        if (additionalDashboardIds != other.additionalDashboardIds) return false
        if (awsAccountId != other.awsAccountId) return false
        if (dashboardId != other.dashboardId) return false
        if (identityType != other.identityType) return false
        if (namespace != other.namespace) return false
        if (resetDisabled != other.resetDisabled) return false
        if (sessionLifetimeInMinutes != other.sessionLifetimeInMinutes) return false
        if (statePersistenceEnabled != other.statePersistenceEnabled) return false
        if (undoRedoDisabled != other.undoRedoDisabled) return false
        if (userArn != other.userArn) return false

        return true
    }

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

    class Builder {
        /**
         * A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The `IdentityType` parameter must be set to `ANONYMOUS` for this to work, because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS`", the session can access all three dashboards.
         */
        var additionalDashboardIds: List? = null
        /**
         * The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
         */
        var awsAccountId: kotlin.String? = null
        /**
         * The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
         */
        var dashboardId: kotlin.String? = null
        /**
         * The authentication method that the user uses to sign in.
         */
        var identityType: aws.sdk.kotlin.services.quicksight.model.EmbeddingIdentityType? = null
        /**
         * The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set `Namespace = default`.
         */
        var namespace: kotlin.String? = null
        /**
         * Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
         */
        var resetDisabled: kotlin.Boolean = false
        /**
         * How many minutes the session is valid. The session lifetime must be 15-600 minutes.
         */
        var sessionLifetimeInMinutes: kotlin.Long? = null
        /**
         * Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to `TRUE`, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is `FALSE`.
         */
        var statePersistenceEnabled: kotlin.Boolean = false
        /**
         * Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
         */
        var undoRedoDisabled: kotlin.Boolean = false
        /**
         * The Amazon QuickSight user's Amazon Resource Name (ARN), for use with `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
         * + Active Directory (AD) users or group members
         * + Invited nonfederated users
         * + IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
         *
         * Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
         */
        var userArn: kotlin.String? = null

        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.quicksight.model.GetDashboardEmbedUrlRequest) : this() {
            this.additionalDashboardIds = x.additionalDashboardIds
            this.awsAccountId = x.awsAccountId
            this.dashboardId = x.dashboardId
            this.identityType = x.identityType
            this.namespace = x.namespace
            this.resetDisabled = x.resetDisabled
            this.sessionLifetimeInMinutes = x.sessionLifetimeInMinutes
            this.statePersistenceEnabled = x.statePersistenceEnabled
            this.undoRedoDisabled = x.undoRedoDisabled
            this.userArn = x.userArn
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.quicksight.model.GetDashboardEmbedUrlRequest = GetDashboardEmbedUrlRequest(this)
    }
}