com.amazonaws.services.quicksight.model.GetSessionEmbedUrlResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* Copyright 2019-2024 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetSessionEmbedUrlResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This
* URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables
* one (and only one) sign-on to a user session that is valid for 10 hours.
*
*/
private String embedUrl;
/**
*
* The HTTP status of the request.
*
*/
private Integer status;
/**
*
* The Amazon Web Services request ID for this operation.
*
*/
private String requestId;
/**
*
* A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This
* URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables
* one (and only one) sign-on to a user session that is valid for 10 hours.
*
*
* @param embedUrl
* A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session.
* This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value
* that enables one (and only one) sign-on to a user session that is valid for 10 hours.
*/
public void setEmbedUrl(String embedUrl) {
this.embedUrl = embedUrl;
}
/**
*
* A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This
* URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables
* one (and only one) sign-on to a user session that is valid for 10 hours.
*
*
* @return A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session.
* This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value
* that enables one (and only one) sign-on to a user session that is valid for 10 hours.
*/
public String getEmbedUrl() {
return this.embedUrl;
}
/**
*
* A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This
* URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables
* one (and only one) sign-on to a user session that is valid for 10 hours.
*
*
* @param embedUrl
* A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session.
* This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value
* that enables one (and only one) sign-on to a user session that is valid for 10 hours.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSessionEmbedUrlResult withEmbedUrl(String embedUrl) {
setEmbedUrl(embedUrl);
return this;
}
/**
*
* The HTTP status of the request.
*
*
* @param status
* The HTTP status of the request.
*/
public void setStatus(Integer status) {
this.status = status;
}
/**
*
* The HTTP status of the request.
*
*
* @return The HTTP status of the request.
*/
public Integer getStatus() {
return this.status;
}
/**
*
* The HTTP status of the request.
*
*
* @param status
* The HTTP status of the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSessionEmbedUrlResult withStatus(Integer status) {
setStatus(status);
return this;
}
/**
*
* The Amazon Web Services request ID for this operation.
*
*
* @param requestId
* The Amazon Web Services request ID for this operation.
*/
public void setRequestId(String requestId) {
this.requestId = requestId;
}
/**
*
* The Amazon Web Services request ID for this operation.
*
*
* @return The Amazon Web Services request ID for this operation.
*/
public String getRequestId() {
return this.requestId;
}
/**
*
* The Amazon Web Services request ID for this operation.
*
*
* @param requestId
* The Amazon Web Services request ID for this operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSessionEmbedUrlResult withRequestId(String requestId) {
setRequestId(requestId);
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 (getEmbedUrl() != null)
sb.append("EmbedUrl: ").append("***Sensitive Data Redacted***").append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getRequestId() != null)
sb.append("RequestId: ").append(getRequestId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetSessionEmbedUrlResult == false)
return false;
GetSessionEmbedUrlResult other = (GetSessionEmbedUrlResult) obj;
if (other.getEmbedUrl() == null ^ this.getEmbedUrl() == null)
return false;
if (other.getEmbedUrl() != null && other.getEmbedUrl().equals(this.getEmbedUrl()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getRequestId() == null ^ this.getRequestId() == null)
return false;
if (other.getRequestId() != null && other.getRequestId().equals(this.getRequestId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEmbedUrl() == null) ? 0 : getEmbedUrl().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getRequestId() == null) ? 0 : getRequestId().hashCode());
return hashCode;
}
@Override
public GetSessionEmbedUrlResult clone() {
try {
return (GetSessionEmbedUrlResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}