/* * 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.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Information about the dashboard you want to embed. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RegisteredUserDashboardEmbeddingConfiguration implements Serializable, Cloneable, StructuredPojo { /** ** The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. * When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to * view it. *
** If the user does not have permission to view this dashboard, they see a permissions error message. *
*/ private String initialDashboardId; /** ** The feature configurations of an embbedded Amazon QuickSight dashboard. *
*/ private RegisteredUserDashboardFeatureConfigurations featureConfigurations; /** ** The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. * When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to * view it. *
** If the user does not have permission to view this dashboard, they see a permissions error message. *
* * @param initialDashboardId * The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output * URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has * permissions to view it. ** If the user does not have permission to view this dashboard, they see a permissions error message. */ public void setInitialDashboardId(String initialDashboardId) { this.initialDashboardId = initialDashboardId; } /** *
* The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. * When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to * view it. *
** If the user does not have permission to view this dashboard, they see a permissions error message. *
* * @return The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output * URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has * permissions to view it. ** If the user does not have permission to view this dashboard, they see a permissions error message. */ public String getInitialDashboardId() { return this.initialDashboardId; } /** *
* The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. * When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to * view it. *
** If the user does not have permission to view this dashboard, they see a permissions error message. *
* * @param initialDashboardId * The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output * URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has * permissions to view it. ** If the user does not have permission to view this dashboard, they see a permissions error message. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisteredUserDashboardEmbeddingConfiguration withInitialDashboardId(String initialDashboardId) { setInitialDashboardId(initialDashboardId); return this; } /** *
* The feature configurations of an embbedded Amazon QuickSight dashboard. *
* * @param featureConfigurations * The feature configurations of an embbedded Amazon QuickSight dashboard. */ public void setFeatureConfigurations(RegisteredUserDashboardFeatureConfigurations featureConfigurations) { this.featureConfigurations = featureConfigurations; } /** ** The feature configurations of an embbedded Amazon QuickSight dashboard. *
* * @return The feature configurations of an embbedded Amazon QuickSight dashboard. */ public RegisteredUserDashboardFeatureConfigurations getFeatureConfigurations() { return this.featureConfigurations; } /** ** The feature configurations of an embbedded Amazon QuickSight dashboard. *
* * @param featureConfigurations * The feature configurations of an embbedded Amazon QuickSight dashboard. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisteredUserDashboardEmbeddingConfiguration withFeatureConfigurations(RegisteredUserDashboardFeatureConfigurations featureConfigurations) { setFeatureConfigurations(featureConfigurations); 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 (getInitialDashboardId() != null) sb.append("InitialDashboardId: ").append(getInitialDashboardId()).append(","); if (getFeatureConfigurations() != null) sb.append("FeatureConfigurations: ").append(getFeatureConfigurations()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof RegisteredUserDashboardEmbeddingConfiguration == false) return false; RegisteredUserDashboardEmbeddingConfiguration other = (RegisteredUserDashboardEmbeddingConfiguration) obj; if (other.getInitialDashboardId() == null ^ this.getInitialDashboardId() == null) return false; if (other.getInitialDashboardId() != null && other.getInitialDashboardId().equals(this.getInitialDashboardId()) == false) return false; if (other.getFeatureConfigurations() == null ^ this.getFeatureConfigurations() == null) return false; if (other.getFeatureConfigurations() != null && other.getFeatureConfigurations().equals(this.getFeatureConfigurations()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getInitialDashboardId() == null) ? 0 : getInitialDashboardId().hashCode()); hashCode = prime * hashCode + ((getFeatureConfigurations() == null) ? 0 : getFeatureConfigurations().hashCode()); return hashCode; } @Override public RegisteredUserDashboardEmbeddingConfiguration clone() { try { return (RegisteredUserDashboardEmbeddingConfiguration) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.quicksight.model.transform.RegisteredUserDashboardEmbeddingConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller); } }