com.amazonaws.services.quicksight.model.GetSessionEmbedUrlRequest Maven / Gradle / Ivy
/*
* 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 GetSessionEmbedUrlRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
*
*/
private String awsAccountId;
/**
*
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
*
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from the
* Amazon QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon
* QuickSight console URL of the analysis
*
*
*
*/
private String entryPoint;
/**
*
* How many minutes the session is valid. The session lifetime must be 15-600 minutes.
*
*/
private Long sessionLifetimeInMinutes;
/**
*
* The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You
* can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to
* be authenticated as one of the following:
*
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* Identity and Access Management (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 ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
*
*
* @param awsAccountId
* The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
*/
public void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
/**
*
* The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
*
*
* @return The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
*/
public String getAwsAccountId() {
return this.awsAccountId;
}
/**
*
* The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
*
*
* @param awsAccountId
* The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSessionEmbedUrlRequest withAwsAccountId(String awsAccountId) {
setAwsAccountId(awsAccountId);
return this;
}
/**
*
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
*
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from the
* Amazon QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon
* QuickSight console URL of the analysis
*
*
*
*
* @param entryPoint
* The URL you use to access the embedded session. The entry point URL is constrained to the following
* paths:
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from
* the Amazon QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the
* Amazon QuickSight console URL of the analysis
*
*
*/
public void setEntryPoint(String entryPoint) {
this.entryPoint = entryPoint;
}
/**
*
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
*
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from the
* Amazon QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon
* QuickSight console URL of the analysis
*
*
*
*
* @return The URL you use to access the embedded session. The entry point URL is constrained to the following
* paths:
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from
* the Amazon QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the
* Amazon QuickSight console URL of the analysis
*
*
*/
public String getEntryPoint() {
return this.entryPoint;
}
/**
*
* The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
*
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from the
* Amazon QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon
* QuickSight console URL of the analysis
*
*
*
*
* @param entryPoint
* The URL you use to access the embedded session. The entry point URL is constrained to the following
* paths:
*
* -
*
* /start
*
*
* -
*
* /start/analyses
*
*
* -
*
* /start/dashboards
*
*
* -
*
* /start/favorites
*
*
* -
*
* /dashboards/DashboardId - where DashboardId is the actual ID key from
* the Amazon QuickSight console URL of the dashboard
*
*
* -
*
* /analyses/AnalysisId - where AnalysisId is the actual ID key from the
* Amazon QuickSight console URL of the analysis
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSessionEmbedUrlRequest withEntryPoint(String entryPoint) {
setEntryPoint(entryPoint);
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 GetSessionEmbedUrlRequest withSessionLifetimeInMinutes(Long sessionLifetimeInMinutes) {
setSessionLifetimeInMinutes(sessionLifetimeInMinutes);
return this;
}
/**
*
* The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You
* can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to
* be authenticated as one of the following:
*
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* Identity and Access Management (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 with QUICKSIGHT identity
* type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or
* admins). They need to be authenticated as one of the following:
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* Identity and Access Management (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 type of Amazon QuickSight users in your account (readers, authors, or admins). They need to
* be authenticated as one of the following:
*
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* Identity and Access Management (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 with QUICKSIGHT identity
* type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or
* admins). They need to be authenticated as one of the following:
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* Identity and Access Management (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 type of Amazon QuickSight users in your account (readers, authors, or admins). They need to
* be authenticated as one of the following:
*
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* Identity and Access Management (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 with QUICKSIGHT identity
* type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or
* admins). They need to be authenticated as one of the following:
*
* -
*
* Active Directory (AD) users or group members
*
*
* -
*
* Invited nonfederated users
*
*
* -
*
* Identity and Access Management (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 GetSessionEmbedUrlRequest 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 (getEntryPoint() != null)
sb.append("EntryPoint: ").append(getEntryPoint()).append(",");
if (getSessionLifetimeInMinutes() != null)
sb.append("SessionLifetimeInMinutes: ").append(getSessionLifetimeInMinutes()).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 GetSessionEmbedUrlRequest == false)
return false;
GetSessionEmbedUrlRequest other = (GetSessionEmbedUrlRequest) obj;
if (other.getAwsAccountId() == null ^ this.getAwsAccountId() == null)
return false;
if (other.getAwsAccountId() != null && other.getAwsAccountId().equals(this.getAwsAccountId()) == false)
return false;
if (other.getEntryPoint() == null ^ this.getEntryPoint() == null)
return false;
if (other.getEntryPoint() != null && other.getEntryPoint().equals(this.getEntryPoint()) == 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.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 + ((getEntryPoint() == null) ? 0 : getEntryPoint().hashCode());
hashCode = prime * hashCode + ((getSessionLifetimeInMinutes() == null) ? 0 : getSessionLifetimeInMinutes().hashCode());
hashCode = prime * hashCode + ((getUserArn() == null) ? 0 : getUserArn().hashCode());
return hashCode;
}
@Override
public GetSessionEmbedUrlRequest clone() {
return (GetSessionEmbedUrlRequest) super.clone();
}
}