/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.quicksight.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetDashboardEmbedUrlRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The ID for the Amazon Web Services account that contains the dashboard that you're embedding. *
*/ private String awsAccountId; /** ** The ID for the dashboard, also added to the Identity and Access Management (IAM) policy. *
*/ private String dashboardId; /** ** The authentication method that the user uses to sign in. *
*/ private String identityType; /** ** How many minutes the session is valid. The session lifetime must be 15-600 minutes. *
*/ private Long sessionLifetimeInMinutes; /** ** Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button. *
*/ private Boolean undoRedoDisabled; /** ** Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. *
*/ private Boolean resetDisabled; /** *
* 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
.
*
* 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. *
*/ private String userArn; /** *
* The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom
* namespace, set Namespace = default
.
*
* A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the
* IdentityType
parameter must be set to ANONYMOUS
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.
*
* The ID for the Amazon Web Services account that contains the dashboard that you're embedding. *
* * @param awsAccountId * The ID for the Amazon Web Services account that contains the dashboard that you're embedding. */ public void setAwsAccountId(String awsAccountId) { this.awsAccountId = awsAccountId; } /** ** The ID for the Amazon Web Services account that contains the dashboard that you're embedding. *
* * @return The ID for the Amazon Web Services account that contains the dashboard that you're embedding. */ public String getAwsAccountId() { return this.awsAccountId; } /** ** The ID for the Amazon Web Services account that contains the dashboard that you're embedding. *
* * @param awsAccountId * The ID for the Amazon Web Services account that contains the dashboard that you're embedding. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDashboardEmbedUrlRequest withAwsAccountId(String awsAccountId) { setAwsAccountId(awsAccountId); return this; } /** ** The ID for the dashboard, also added to the Identity and Access Management (IAM) policy. *
* * @param dashboardId * The ID for the dashboard, also added to the Identity and Access Management (IAM) policy. */ public void setDashboardId(String dashboardId) { this.dashboardId = dashboardId; } /** ** The ID for the dashboard, also added to the Identity and Access Management (IAM) policy. *
* * @return The ID for the dashboard, also added to the Identity and Access Management (IAM) policy. */ public String getDashboardId() { return this.dashboardId; } /** ** The ID for the dashboard, also added to the Identity and Access Management (IAM) policy. *
* * @param dashboardId * The ID for the dashboard, also added to the Identity and Access Management (IAM) policy. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDashboardEmbedUrlRequest withDashboardId(String dashboardId) { setDashboardId(dashboardId); return this; } /** ** The authentication method that the user uses to sign in. *
* * @param identityType * The authentication method that the user uses to sign in. * @see EmbeddingIdentityType */ public void setIdentityType(String identityType) { this.identityType = identityType; } /** ** The authentication method that the user uses to sign in. *
* * @return The authentication method that the user uses to sign in. * @see EmbeddingIdentityType */ public String getIdentityType() { return this.identityType; } /** ** The authentication method that the user uses to sign in. *
* * @param identityType * The authentication method that the user uses to sign in. * @return Returns a reference to this object so that method calls can be chained together. * @see EmbeddingIdentityType */ public GetDashboardEmbedUrlRequest withIdentityType(String identityType) { setIdentityType(identityType); return this; } /** ** The authentication method that the user uses to sign in. *
* * @param identityType * The authentication method that the user uses to sign in. * @return Returns a reference to this object so that method calls can be chained together. * @see EmbeddingIdentityType */ public GetDashboardEmbedUrlRequest withIdentityType(EmbeddingIdentityType identityType) { this.identityType = identityType.toString(); return this; } /** ** How many minutes the session is valid. The session lifetime must be 15-600 minutes. *
* * @param sessionLifetimeInMinutes * How many minutes the session is valid. The session lifetime must be 15-600 minutes. */ public void setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) { this.sessionLifetimeInMinutes = sessionLifetimeInMinutes; } /** ** How many minutes the session is valid. The session lifetime must be 15-600 minutes. *
* * @return How many minutes the session is valid. The session lifetime must be 15-600 minutes. */ public Long getSessionLifetimeInMinutes() { return this.sessionLifetimeInMinutes; } /** ** How many minutes the session is valid. The session lifetime must be 15-600 minutes. *
* * @param sessionLifetimeInMinutes * How many minutes the session is valid. The session lifetime must be 15-600 minutes. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDashboardEmbedUrlRequest withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) { setSessionLifetimeInMinutes(sessionLifetimeInMinutes); return this; } /** ** Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button. *
* * @param undoRedoDisabled * Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo * button. */ public void setUndoRedoDisabled(Boolean undoRedoDisabled) { this.undoRedoDisabled = undoRedoDisabled; } /** ** Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button. *
* * @return Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo * button. */ public Boolean getUndoRedoDisabled() { return this.undoRedoDisabled; } /** ** Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button. *
* * @param undoRedoDisabled * Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo * button. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDashboardEmbedUrlRequest withUndoRedoDisabled(Boolean undoRedoDisabled) { setUndoRedoDisabled(undoRedoDisabled); return this; } /** ** Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button. *
* * @return Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo * button. */ public Boolean isUndoRedoDisabled() { return this.undoRedoDisabled; } /** ** Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. *
* * @param resetDisabled * Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. */ public void setResetDisabled(Boolean resetDisabled) { this.resetDisabled = resetDisabled; } /** ** Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. *
* * @return Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. */ public Boolean getResetDisabled() { return this.resetDisabled; } /** ** Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. *
* * @param resetDisabled * Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDashboardEmbedUrlRequest withResetDisabled(Boolean resetDisabled) { setResetDisabled(resetDisabled); return this; } /** ** Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. *
* * @return Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button. */ public Boolean isResetDisabled() { return this.resetDisabled; } /** *
* 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
.
*
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
.
*/
public void setStatePersistenceEnabled(Boolean statePersistenceEnabled) {
this.statePersistenceEnabled = statePersistenceEnabled;
}
/**
*
* 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
.
*
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
.
*/
public Boolean getStatePersistenceEnabled() {
return this.statePersistenceEnabled;
}
/**
*
* 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
.
*
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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDashboardEmbedUrlRequest withStatePersistenceEnabled(Boolean statePersistenceEnabled) {
setStatePersistenceEnabled(statePersistenceEnabled);
return this;
}
/**
*
* 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
.
*
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
.
*/
public Boolean isStatePersistenceEnabled() {
return this.statePersistenceEnabled;
}
/**
*
* 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. *
* * @param userArn * The Amazon QuickSight user's Amazon Resource Name (ARN), for use withQUICKSIGHT
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. */ public void setUserArn(String userArn) { this.userArn = userArn; } /** *
* 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. *
* * @return The Amazon QuickSight user's Amazon Resource Name (ARN), for use withQUICKSIGHT
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. */ public String getUserArn() { return this.userArn; } /** *
* 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. *
* * @param userArn * The Amazon QuickSight user's Amazon Resource Name (ARN), for use withQUICKSIGHT
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. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDashboardEmbedUrlRequest withUserArn(String userArn) { setUserArn(userArn); return this; } /** *
* The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom
* namespace, set Namespace = default
.
*
Namespace = default
.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
*
* The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom
* namespace, set Namespace = default
.
*
Namespace = default
.
*/
public String getNamespace() {
return this.namespace;
}
/**
*
* The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom
* namespace, set Namespace = default
.
*
Namespace = default
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDashboardEmbedUrlRequest withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the
* IdentityType
parameter must be set to ANONYMOUS
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.
*
IdentityType
parameter must be set to ANONYMOUS
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.
*/
public java.util.List
* A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the
* IdentityType
parameter must be set to ANONYMOUS
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.
*
IdentityType
parameter must be set to ANONYMOUS
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.
*/
public void setAdditionalDashboardIds(java.util.Collection
* A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the
* IdentityType
parameter must be set to ANONYMOUS
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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setAdditionalDashboardIds(java.util.Collection)} or * {@link #withAdditionalDashboardIds(java.util.Collection)} if you want to override the existing values. *
* * @param additionalDashboardIds * A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, * theIdentityType
parameter must be set to ANONYMOUS
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDashboardEmbedUrlRequest withAdditionalDashboardIds(String... additionalDashboardIds) {
if (this.additionalDashboardIds == null) {
setAdditionalDashboardIds(new java.util.ArrayList
* A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the
* IdentityType
parameter must be set to ANONYMOUS
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.
*
IdentityType
parameter must be set to ANONYMOUS
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDashboardEmbedUrlRequest withAdditionalDashboardIds(java.util.Collection