com.amazonaws.services.quicksight.model.HeatMapVisual 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;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A heat map.
*
*
* For more information, see Using heat
* maps in the Amazon QuickSight User Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class HeatMapVisual implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or
* analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*
*/
private String visualId;
/**
*
* The title that is displayed on the visual.
*
*/
private VisualTitleLabelOptions title;
/**
*
* The subtitle that is displayed on the visual.
*
*/
private VisualSubtitleLabelOptions subtitle;
/**
*
* The configuration of a heat map.
*
*/
private HeatMapConfiguration chartConfiguration;
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
*/
private java.util.List columnHierarchies;
/**
*
* The list of custom actions that are configured for a visual.
*
*/
private java.util.List actions;
/**
*
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or
* analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*
*
* @param visualId
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard,
* template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*/
public void setVisualId(String visualId) {
this.visualId = visualId;
}
/**
*
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or
* analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*
*
* @return The unique identifier of a visual. This identifier must be unique within the context of a dashboard,
* template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*/
public String getVisualId() {
return this.visualId;
}
/**
*
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or
* analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
*
*
* @param visualId
* The unique identifier of a visual. This identifier must be unique within the context of a dashboard,
* template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HeatMapVisual withVisualId(String visualId) {
setVisualId(visualId);
return this;
}
/**
*
* The title that is displayed on the visual.
*
*
* @param title
* The title that is displayed on the visual.
*/
public void setTitle(VisualTitleLabelOptions title) {
this.title = title;
}
/**
*
* The title that is displayed on the visual.
*
*
* @return The title that is displayed on the visual.
*/
public VisualTitleLabelOptions getTitle() {
return this.title;
}
/**
*
* The title that is displayed on the visual.
*
*
* @param title
* The title that is displayed on the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HeatMapVisual withTitle(VisualTitleLabelOptions title) {
setTitle(title);
return this;
}
/**
*
* The subtitle that is displayed on the visual.
*
*
* @param subtitle
* The subtitle that is displayed on the visual.
*/
public void setSubtitle(VisualSubtitleLabelOptions subtitle) {
this.subtitle = subtitle;
}
/**
*
* The subtitle that is displayed on the visual.
*
*
* @return The subtitle that is displayed on the visual.
*/
public VisualSubtitleLabelOptions getSubtitle() {
return this.subtitle;
}
/**
*
* The subtitle that is displayed on the visual.
*
*
* @param subtitle
* The subtitle that is displayed on the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HeatMapVisual withSubtitle(VisualSubtitleLabelOptions subtitle) {
setSubtitle(subtitle);
return this;
}
/**
*
* The configuration of a heat map.
*
*
* @param chartConfiguration
* The configuration of a heat map.
*/
public void setChartConfiguration(HeatMapConfiguration chartConfiguration) {
this.chartConfiguration = chartConfiguration;
}
/**
*
* The configuration of a heat map.
*
*
* @return The configuration of a heat map.
*/
public HeatMapConfiguration getChartConfiguration() {
return this.chartConfiguration;
}
/**
*
* The configuration of a heat map.
*
*
* @param chartConfiguration
* The configuration of a heat map.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HeatMapVisual withChartConfiguration(HeatMapConfiguration chartConfiguration) {
setChartConfiguration(chartConfiguration);
return this;
}
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
*
* @return The column hierarchy that is used during drill-downs and drill-ups.
*/
public java.util.List getColumnHierarchies() {
return columnHierarchies;
}
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
*
* @param columnHierarchies
* The column hierarchy that is used during drill-downs and drill-ups.
*/
public void setColumnHierarchies(java.util.Collection columnHierarchies) {
if (columnHierarchies == null) {
this.columnHierarchies = null;
return;
}
this.columnHierarchies = new java.util.ArrayList(columnHierarchies);
}
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setColumnHierarchies(java.util.Collection)} or {@link #withColumnHierarchies(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param columnHierarchies
* The column hierarchy that is used during drill-downs and drill-ups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HeatMapVisual withColumnHierarchies(ColumnHierarchy... columnHierarchies) {
if (this.columnHierarchies == null) {
setColumnHierarchies(new java.util.ArrayList(columnHierarchies.length));
}
for (ColumnHierarchy ele : columnHierarchies) {
this.columnHierarchies.add(ele);
}
return this;
}
/**
*
* The column hierarchy that is used during drill-downs and drill-ups.
*
*
* @param columnHierarchies
* The column hierarchy that is used during drill-downs and drill-ups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HeatMapVisual withColumnHierarchies(java.util.Collection columnHierarchies) {
setColumnHierarchies(columnHierarchies);
return this;
}
/**
*
* The list of custom actions that are configured for a visual.
*
*
* @return The list of custom actions that are configured for a visual.
*/
public java.util.List getActions() {
return actions;
}
/**
*
* The list of custom actions that are configured for a visual.
*
*
* @param actions
* The list of custom actions that are configured for a visual.
*/
public void setActions(java.util.Collection actions) {
if (actions == null) {
this.actions = null;
return;
}
this.actions = new java.util.ArrayList(actions);
}
/**
*
* The list of custom actions that are configured for a visual.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setActions(java.util.Collection)} or {@link #withActions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param actions
* The list of custom actions that are configured for a visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HeatMapVisual withActions(VisualCustomAction... actions) {
if (this.actions == null) {
setActions(new java.util.ArrayList(actions.length));
}
for (VisualCustomAction ele : actions) {
this.actions.add(ele);
}
return this;
}
/**
*
* The list of custom actions that are configured for a visual.
*
*
* @param actions
* The list of custom actions that are configured for a visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HeatMapVisual withActions(java.util.Collection actions) {
setActions(actions);
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 (getVisualId() != null)
sb.append("VisualId: ").append(getVisualId()).append(",");
if (getTitle() != null)
sb.append("Title: ").append(getTitle()).append(",");
if (getSubtitle() != null)
sb.append("Subtitle: ").append(getSubtitle()).append(",");
if (getChartConfiguration() != null)
sb.append("ChartConfiguration: ").append(getChartConfiguration()).append(",");
if (getColumnHierarchies() != null)
sb.append("ColumnHierarchies: ").append(getColumnHierarchies()).append(",");
if (getActions() != null)
sb.append("Actions: ").append(getActions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof HeatMapVisual == false)
return false;
HeatMapVisual other = (HeatMapVisual) obj;
if (other.getVisualId() == null ^ this.getVisualId() == null)
return false;
if (other.getVisualId() != null && other.getVisualId().equals(this.getVisualId()) == false)
return false;
if (other.getTitle() == null ^ this.getTitle() == null)
return false;
if (other.getTitle() != null && other.getTitle().equals(this.getTitle()) == false)
return false;
if (other.getSubtitle() == null ^ this.getSubtitle() == null)
return false;
if (other.getSubtitle() != null && other.getSubtitle().equals(this.getSubtitle()) == false)
return false;
if (other.getChartConfiguration() == null ^ this.getChartConfiguration() == null)
return false;
if (other.getChartConfiguration() != null && other.getChartConfiguration().equals(this.getChartConfiguration()) == false)
return false;
if (other.getColumnHierarchies() == null ^ this.getColumnHierarchies() == null)
return false;
if (other.getColumnHierarchies() != null && other.getColumnHierarchies().equals(this.getColumnHierarchies()) == false)
return false;
if (other.getActions() == null ^ this.getActions() == null)
return false;
if (other.getActions() != null && other.getActions().equals(this.getActions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVisualId() == null) ? 0 : getVisualId().hashCode());
hashCode = prime * hashCode + ((getTitle() == null) ? 0 : getTitle().hashCode());
hashCode = prime * hashCode + ((getSubtitle() == null) ? 0 : getSubtitle().hashCode());
hashCode = prime * hashCode + ((getChartConfiguration() == null) ? 0 : getChartConfiguration().hashCode());
hashCode = prime * hashCode + ((getColumnHierarchies() == null) ? 0 : getColumnHierarchies().hashCode());
hashCode = prime * hashCode + ((getActions() == null) ? 0 : getActions().hashCode());
return hashCode;
}
@Override
public HeatMapVisual clone() {
try {
return (HeatMapVisual) 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.HeatMapVisualMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}