@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetDashboardEmbedUrlRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
GetDashboardEmbedUrlRequest() |
| Modifier and Type | Method and Description |
|---|---|
GetDashboardEmbedUrlRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAwsAccountId()
The ID for the AWS account that contains the dashboard that you're embedding.
|
String |
getDashboardId()
The ID for the dashboard, also added to the IAM policy.
|
String |
getIdentityType()
The authentication method that the user uses to sign in.
|
Boolean |
getResetDisabled()
Remove the reset button on the embedded dashboard.
|
Long |
getSessionLifetimeInMinutes()
How many minutes the session is valid.
|
Boolean |
getStatePersistenceEnabled()
Adds persistence of state for the user session in an embedded dashboard.
|
Boolean |
getUndoRedoDisabled()
Remove the undo/redo button on the embedded dashboard.
|
String |
getUserArn()
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
QUICKSIGHT identity type. |
int |
hashCode() |
Boolean |
isResetDisabled()
Remove the reset button on the embedded dashboard.
|
Boolean |
isStatePersistenceEnabled()
Adds persistence of state for the user session in an embedded dashboard.
|
Boolean |
isUndoRedoDisabled()
Remove the undo/redo button on the embedded dashboard.
|
void |
setAwsAccountId(String awsAccountId)
The ID for the AWS account that contains the dashboard that you're embedding.
|
void |
setDashboardId(String dashboardId)
The ID for the dashboard, also added to the IAM policy.
|
void |
setIdentityType(String identityType)
The authentication method that the user uses to sign in.
|
void |
setResetDisabled(Boolean resetDisabled)
Remove the reset button on the embedded dashboard.
|
void |
setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes)
How many minutes the session is valid.
|
void |
setStatePersistenceEnabled(Boolean statePersistenceEnabled)
Adds persistence of state for the user session in an embedded dashboard.
|
void |
setUndoRedoDisabled(Boolean undoRedoDisabled)
Remove the undo/redo button on the embedded dashboard.
|
void |
setUserArn(String userArn)
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
QUICKSIGHT identity type. |
String |
toString()
Returns a string representation of this object.
|
GetDashboardEmbedUrlRequest |
withAwsAccountId(String awsAccountId)
The ID for the AWS account that contains the dashboard that you're embedding.
|
GetDashboardEmbedUrlRequest |
withDashboardId(String dashboardId)
The ID for the dashboard, also added to the IAM policy.
|
GetDashboardEmbedUrlRequest |
withIdentityType(IdentityType identityType)
The authentication method that the user uses to sign in.
|
GetDashboardEmbedUrlRequest |
withIdentityType(String identityType)
The authentication method that the user uses to sign in.
|
GetDashboardEmbedUrlRequest |
withResetDisabled(Boolean resetDisabled)
Remove the reset button on the embedded dashboard.
|
GetDashboardEmbedUrlRequest |
withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes)
How many minutes the session is valid.
|
GetDashboardEmbedUrlRequest |
withStatePersistenceEnabled(Boolean statePersistenceEnabled)
Adds persistence of state for the user session in an embedded dashboard.
|
GetDashboardEmbedUrlRequest |
withUndoRedoDisabled(Boolean undoRedoDisabled)
Remove the undo/redo button on the embedded dashboard.
|
GetDashboardEmbedUrlRequest |
withUserArn(String userArn)
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
QUICKSIGHT identity type. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setAwsAccountId(String awsAccountId)
The ID for the AWS account that contains the dashboard that you're embedding.
awsAccountId - The ID for the AWS account that contains the dashboard that you're embedding.public String getAwsAccountId()
The ID for the AWS account that contains the dashboard that you're embedding.
public GetDashboardEmbedUrlRequest withAwsAccountId(String awsAccountId)
The ID for the AWS account that contains the dashboard that you're embedding.
awsAccountId - The ID for the AWS account that contains the dashboard that you're embedding.public void setDashboardId(String dashboardId)
The ID for the dashboard, also added to the IAM policy.
dashboardId - The ID for the dashboard, also added to the IAM policy.public String getDashboardId()
The ID for the dashboard, also added to the IAM policy.
public GetDashboardEmbedUrlRequest withDashboardId(String dashboardId)
The ID for the dashboard, also added to the IAM policy.
dashboardId - The ID for the dashboard, also added to the IAM policy.public void setIdentityType(String identityType)
The authentication method that the user uses to sign in.
identityType - The authentication method that the user uses to sign in.IdentityTypepublic String getIdentityType()
The authentication method that the user uses to sign in.
IdentityTypepublic GetDashboardEmbedUrlRequest withIdentityType(String identityType)
The authentication method that the user uses to sign in.
identityType - The authentication method that the user uses to sign in.IdentityTypepublic GetDashboardEmbedUrlRequest withIdentityType(IdentityType identityType)
The authentication method that the user uses to sign in.
identityType - The authentication method that the user uses to sign in.IdentityTypepublic void setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes)
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be 15-600 minutes.public Long getSessionLifetimeInMinutes()
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
public GetDashboardEmbedUrlRequest withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes)
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be 15-600 minutes.public void setUndoRedoDisabled(Boolean undoRedoDisabled)
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
undoRedoDisabled - Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo
button.public Boolean getUndoRedoDisabled()
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
public GetDashboardEmbedUrlRequest withUndoRedoDisabled(Boolean undoRedoDisabled)
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
undoRedoDisabled - Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo
button.public Boolean isUndoRedoDisabled()
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
public void setResetDisabled(Boolean resetDisabled)
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
resetDisabled - Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.public Boolean getResetDisabled()
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
public GetDashboardEmbedUrlRequest withResetDisabled(Boolean resetDisabled)
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
resetDisabled - Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.public Boolean isResetDisabled()
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
public void setStatePersistenceEnabled(Boolean 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 (QuickSight reader) chooses while
viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber
reopens the same dashboard URL. The state is stored in 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.
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 (QuickSight reader)
chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when
the the subscriber reopens the same dashboard URL. The state is stored in 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()
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 (QuickSight reader) chooses while
viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber
reopens the same dashboard URL. The state is stored in 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 the subscriber reopens the same dashboard URL. The state is stored in 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 GetDashboardEmbedUrlRequest withStatePersistenceEnabled(Boolean 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 (QuickSight reader) chooses while
viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber
reopens the same dashboard URL. The state is stored in 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.
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 (QuickSight reader)
chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when
the the subscriber reopens the same dashboard URL. The state is stored in 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()
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 (QuickSight reader) chooses while
viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber
reopens the same dashboard URL. The state is stored in 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 the subscriber reopens the same dashboard URL. The state is stored in 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 setUserArn(String 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.
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.
public String getUserArn()
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.
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.
public GetDashboardEmbedUrlRequest withUserArn(String 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.
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.
public String toString()
toString in class ObjectObject.toString()public GetDashboardEmbedUrlRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()