com.amazonaws.services.quicksight.model.GetDashboardEmbedUrlRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* Copyright 2014-2019 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 {
/**
*
* AWS account ID that contains the dashboard you are embedding.
*
*/
private String awsAccountId;
/**
*
* The ID for the dashboard, also added to IAM policy
*
*/
private String dashboardId;
/**
*
* The authentication method the user uses to sign in.
*
*/
private String identityType;
/**
*
* How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
*
*/
private Long sessionLifetimeInMinutes;
/**
*
* Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.
*
*/
private Boolean undoRedoDisabled;
/**
*
* Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
*
*/
private Boolean resetDisabled;
/**
*
* 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 non-federated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect,
* or IAM Federation
*
*
*
*/
private String userArn;
/**
*
* AWS account ID that contains the dashboard you are embedding.
*
*
* @param awsAccountId
* AWS account ID that contains the dashboard you are embedding.
*/
public void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
/**
*
* AWS account ID that contains the dashboard you are embedding.
*
*
* @return AWS account ID that contains the dashboard you are embedding.
*/
public String getAwsAccountId() {
return this.awsAccountId;
}
/**
*
* AWS account ID that contains the dashboard you are embedding.
*
*
* @param awsAccountId
* AWS account ID that contains the dashboard you are 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 IAM policy
*
*
* @param dashboardId
* The ID for the dashboard, also added to IAM policy
*/
public void setDashboardId(String dashboardId) {
this.dashboardId = dashboardId;
}
/**
*
* The ID for the dashboard, also added to IAM policy
*
*
* @return The ID for the dashboard, also added to IAM policy
*/
public String getDashboardId() {
return this.dashboardId;
}
/**
*
* The ID for the dashboard, also added to IAM policy
*
*
* @param dashboardId
* The ID for the dashboard, also added to 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 the user uses to sign in.
*
*
* @param identityType
* The authentication method the user uses to sign in.
* @see IdentityType
*/
public void setIdentityType(String identityType) {
this.identityType = identityType;
}
/**
*
* The authentication method the user uses to sign in.
*
*
* @return The authentication method the user uses to sign in.
* @see IdentityType
*/
public String getIdentityType() {
return this.identityType;
}
/**
*
* The authentication method the user uses to sign in.
*
*
* @param identityType
* The authentication method the user uses to sign in.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IdentityType
*/
public GetDashboardEmbedUrlRequest withIdentityType(String identityType) {
setIdentityType(identityType);
return this;
}
/**
*
* The authentication method the user uses to sign in.
*
*
* @param identityType
* The authentication method the user uses to sign in.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IdentityType
*/
public GetDashboardEmbedUrlRequest withIdentityType(IdentityType identityType) {
this.identityType = identityType.toString();
return this;
}
/**
*
* How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
*
*
* @param sessionLifetimeInMinutes
* How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
*/
public void setSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) {
this.sessionLifetimeInMinutes = sessionLifetimeInMinutes;
}
/**
*
* How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
*
*
* @return How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
*/
public Long getSessionLifetimeInMinutes() {
return this.sessionLifetimeInMinutes;
}
/**
*
* How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
*
*
* @param sessionLifetimeInMinutes
* How many minutes the session is valid. The session lifetime must be between 15 and 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 embedded dashboard. The default is FALSE, which enables the undo/redo button.
*
*
* @param undoRedoDisabled
* Remove the undo/redo button on 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 embedded dashboard. The default is FALSE, which enables the undo/redo button.
*
*
* @return Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo
* button.
*/
public Boolean getUndoRedoDisabled() {
return this.undoRedoDisabled;
}
/**
*
* Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.
*
*
* @param undoRedoDisabled
* Remove the undo/redo button on 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 embedded dashboard. The default is FALSE, which enables the undo/redo button.
*
*
* @return Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo
* button.
*/
public Boolean isUndoRedoDisabled() {
return this.undoRedoDisabled;
}
/**
*
* Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
*
*
* @param resetDisabled
* Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
*/
public void setResetDisabled(Boolean resetDisabled) {
this.resetDisabled = resetDisabled;
}
/**
*
* Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
*
*
* @return Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
*/
public Boolean getResetDisabled() {
return this.resetDisabled;
}
/**
*
* Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
*
*
* @param resetDisabled
* Remove the reset button on embedded dashboard. The default is FALSE, which allows 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 embedded dashboard. The default is FALSE, which allows the reset button.
*
*
* @return Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
*/
public Boolean isResetDisabled() {
return this.resetDisabled;
}
/**
*
* 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 non-federated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect,
* or IAM Federation
*
*
*
*
* @param 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 non-federated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID
* Connect, or IAM Federation
*
*
*/
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 non-federated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect,
* or IAM Federation
*
*
*
*
* @return 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 non-federated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID
* Connect, or IAM Federation
*
*
*/
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 non-federated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect,
* or IAM Federation
*
*
*
*
* @param 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 non-federated users
*
*
* -
*
* IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID
* Connect, or IAM Federation
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDashboardEmbedUrlRequest withUserArn(String userArn) {
setUserArn(userArn);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAwsAccountId() != null)
sb.append("AwsAccountId: ").append(getAwsAccountId()).append(",");
if (getDashboardId() != null)
sb.append("DashboardId: ").append(getDashboardId()).append(",");
if (getIdentityType() != null)
sb.append("IdentityType: ").append(getIdentityType()).append(",");
if (getSessionLifetimeInMinutes() != null)
sb.append("SessionLifetimeInMinutes: ").append(getSessionLifetimeInMinutes()).append(",");
if (getUndoRedoDisabled() != null)
sb.append("UndoRedoDisabled: ").append(getUndoRedoDisabled()).append(",");
if (getResetDisabled() != null)
sb.append("ResetDisabled: ").append(getResetDisabled()).append(",");
if (getUserArn() != null)
sb.append("UserArn: ").append(getUserArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetDashboardEmbedUrlRequest == false)
return false;
GetDashboardEmbedUrlRequest other = (GetDashboardEmbedUrlRequest) obj;
if (other.getAwsAccountId() == null ^ this.getAwsAccountId() == null)
return false;
if (other.getAwsAccountId() != null && other.getAwsAccountId().equals(this.getAwsAccountId()) == false)
return false;
if (other.getDashboardId() == null ^ this.getDashboardId() == null)
return false;
if (other.getDashboardId() != null && other.getDashboardId().equals(this.getDashboardId()) == false)
return false;
if (other.getIdentityType() == null ^ this.getIdentityType() == null)
return false;
if (other.getIdentityType() != null && other.getIdentityType().equals(this.getIdentityType()) == false)
return false;
if (other.getSessionLifetimeInMinutes() == null ^ this.getSessionLifetimeInMinutes() == null)
return false;
if (other.getSessionLifetimeInMinutes() != null && other.getSessionLifetimeInMinutes().equals(this.getSessionLifetimeInMinutes()) == false)
return false;
if (other.getUndoRedoDisabled() == null ^ this.getUndoRedoDisabled() == null)
return false;
if (other.getUndoRedoDisabled() != null && other.getUndoRedoDisabled().equals(this.getUndoRedoDisabled()) == false)
return false;
if (other.getResetDisabled() == null ^ this.getResetDisabled() == null)
return false;
if (other.getResetDisabled() != null && other.getResetDisabled().equals(this.getResetDisabled()) == false)
return false;
if (other.getUserArn() == null ^ this.getUserArn() == null)
return false;
if (other.getUserArn() != null && other.getUserArn().equals(this.getUserArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAwsAccountId() == null) ? 0 : getAwsAccountId().hashCode());
hashCode = prime * hashCode + ((getDashboardId() == null) ? 0 : getDashboardId().hashCode());
hashCode = prime * hashCode + ((getIdentityType() == null) ? 0 : getIdentityType().hashCode());
hashCode = prime * hashCode + ((getSessionLifetimeInMinutes() == null) ? 0 : getSessionLifetimeInMinutes().hashCode());
hashCode = prime * hashCode + ((getUndoRedoDisabled() == null) ? 0 : getUndoRedoDisabled().hashCode());
hashCode = prime * hashCode + ((getResetDisabled() == null) ? 0 : getResetDisabled().hashCode());
hashCode = prime * hashCode + ((getUserArn() == null) ? 0 : getUserArn().hashCode());
return hashCode;
}
@Override
public GetDashboardEmbedUrlRequest clone() {
return (GetDashboardEmbedUrlRequest) super.clone();
}
}