com.amazonaws.services.quicksight.model.FunnelChartConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* 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;
/**
*
* The configuration of a FunnelChartVisual
.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class FunnelChartConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The field well configuration of a FunnelChartVisual
.
*
*/
private FunnelChartFieldWells fieldWells;
/**
*
* The sort configuration of a FunnelChartVisual
.
*
*/
private FunnelChartSortConfiguration sortConfiguration;
/**
*
* The label options of the categories that are displayed in a FunnelChartVisual
.
*
*/
private ChartAxisLabelOptions categoryLabelOptions;
/**
*
* The label options for the values that are displayed in a FunnelChartVisual
.
*
*/
private ChartAxisLabelOptions valueLabelOptions;
/**
*
* The tooltip configuration of a FunnelChartVisual
.
*
*/
private TooltipOptions tooltip;
/**
*
* The options that determine the presentation of the data labels.
*
*/
private FunnelChartDataLabelOptions dataLabelOptions;
/**
*
* The visual palette configuration of a FunnelChartVisual
.
*
*/
private VisualPalette visualPalette;
/**
*
* The field well configuration of a FunnelChartVisual
.
*
*
* @param fieldWells
* The field well configuration of a FunnelChartVisual
.
*/
public void setFieldWells(FunnelChartFieldWells fieldWells) {
this.fieldWells = fieldWells;
}
/**
*
* The field well configuration of a FunnelChartVisual
.
*
*
* @return The field well configuration of a FunnelChartVisual
.
*/
public FunnelChartFieldWells getFieldWells() {
return this.fieldWells;
}
/**
*
* The field well configuration of a FunnelChartVisual
.
*
*
* @param fieldWells
* The field well configuration of a FunnelChartVisual
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunnelChartConfiguration withFieldWells(FunnelChartFieldWells fieldWells) {
setFieldWells(fieldWells);
return this;
}
/**
*
* The sort configuration of a FunnelChartVisual
.
*
*
* @param sortConfiguration
* The sort configuration of a FunnelChartVisual
.
*/
public void setSortConfiguration(FunnelChartSortConfiguration sortConfiguration) {
this.sortConfiguration = sortConfiguration;
}
/**
*
* The sort configuration of a FunnelChartVisual
.
*
*
* @return The sort configuration of a FunnelChartVisual
.
*/
public FunnelChartSortConfiguration getSortConfiguration() {
return this.sortConfiguration;
}
/**
*
* The sort configuration of a FunnelChartVisual
.
*
*
* @param sortConfiguration
* The sort configuration of a FunnelChartVisual
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunnelChartConfiguration withSortConfiguration(FunnelChartSortConfiguration sortConfiguration) {
setSortConfiguration(sortConfiguration);
return this;
}
/**
*
* The label options of the categories that are displayed in a FunnelChartVisual
.
*
*
* @param categoryLabelOptions
* The label options of the categories that are displayed in a FunnelChartVisual
.
*/
public void setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) {
this.categoryLabelOptions = categoryLabelOptions;
}
/**
*
* The label options of the categories that are displayed in a FunnelChartVisual
.
*
*
* @return The label options of the categories that are displayed in a FunnelChartVisual
.
*/
public ChartAxisLabelOptions getCategoryLabelOptions() {
return this.categoryLabelOptions;
}
/**
*
* The label options of the categories that are displayed in a FunnelChartVisual
.
*
*
* @param categoryLabelOptions
* The label options of the categories that are displayed in a FunnelChartVisual
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunnelChartConfiguration withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) {
setCategoryLabelOptions(categoryLabelOptions);
return this;
}
/**
*
* The label options for the values that are displayed in a FunnelChartVisual
.
*
*
* @param valueLabelOptions
* The label options for the values that are displayed in a FunnelChartVisual
.
*/
public void setValueLabelOptions(ChartAxisLabelOptions valueLabelOptions) {
this.valueLabelOptions = valueLabelOptions;
}
/**
*
* The label options for the values that are displayed in a FunnelChartVisual
.
*
*
* @return The label options for the values that are displayed in a FunnelChartVisual
.
*/
public ChartAxisLabelOptions getValueLabelOptions() {
return this.valueLabelOptions;
}
/**
*
* The label options for the values that are displayed in a FunnelChartVisual
.
*
*
* @param valueLabelOptions
* The label options for the values that are displayed in a FunnelChartVisual
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunnelChartConfiguration withValueLabelOptions(ChartAxisLabelOptions valueLabelOptions) {
setValueLabelOptions(valueLabelOptions);
return this;
}
/**
*
* The tooltip configuration of a FunnelChartVisual
.
*
*
* @param tooltip
* The tooltip configuration of a FunnelChartVisual
.
*/
public void setTooltip(TooltipOptions tooltip) {
this.tooltip = tooltip;
}
/**
*
* The tooltip configuration of a FunnelChartVisual
.
*
*
* @return The tooltip configuration of a FunnelChartVisual
.
*/
public TooltipOptions getTooltip() {
return this.tooltip;
}
/**
*
* The tooltip configuration of a FunnelChartVisual
.
*
*
* @param tooltip
* The tooltip configuration of a FunnelChartVisual
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunnelChartConfiguration withTooltip(TooltipOptions tooltip) {
setTooltip(tooltip);
return this;
}
/**
*
* The options that determine the presentation of the data labels.
*
*
* @param dataLabelOptions
* The options that determine the presentation of the data labels.
*/
public void setDataLabelOptions(FunnelChartDataLabelOptions dataLabelOptions) {
this.dataLabelOptions = dataLabelOptions;
}
/**
*
* The options that determine the presentation of the data labels.
*
*
* @return The options that determine the presentation of the data labels.
*/
public FunnelChartDataLabelOptions getDataLabelOptions() {
return this.dataLabelOptions;
}
/**
*
* The options that determine the presentation of the data labels.
*
*
* @param dataLabelOptions
* The options that determine the presentation of the data labels.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunnelChartConfiguration withDataLabelOptions(FunnelChartDataLabelOptions dataLabelOptions) {
setDataLabelOptions(dataLabelOptions);
return this;
}
/**
*
* The visual palette configuration of a FunnelChartVisual
.
*
*
* @param visualPalette
* The visual palette configuration of a FunnelChartVisual
.
*/
public void setVisualPalette(VisualPalette visualPalette) {
this.visualPalette = visualPalette;
}
/**
*
* The visual palette configuration of a FunnelChartVisual
.
*
*
* @return The visual palette configuration of a FunnelChartVisual
.
*/
public VisualPalette getVisualPalette() {
return this.visualPalette;
}
/**
*
* The visual palette configuration of a FunnelChartVisual
.
*
*
* @param visualPalette
* The visual palette configuration of a FunnelChartVisual
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FunnelChartConfiguration withVisualPalette(VisualPalette visualPalette) {
setVisualPalette(visualPalette);
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 (getFieldWells() != null)
sb.append("FieldWells: ").append(getFieldWells()).append(",");
if (getSortConfiguration() != null)
sb.append("SortConfiguration: ").append(getSortConfiguration()).append(",");
if (getCategoryLabelOptions() != null)
sb.append("CategoryLabelOptions: ").append(getCategoryLabelOptions()).append(",");
if (getValueLabelOptions() != null)
sb.append("ValueLabelOptions: ").append(getValueLabelOptions()).append(",");
if (getTooltip() != null)
sb.append("Tooltip: ").append(getTooltip()).append(",");
if (getDataLabelOptions() != null)
sb.append("DataLabelOptions: ").append(getDataLabelOptions()).append(",");
if (getVisualPalette() != null)
sb.append("VisualPalette: ").append(getVisualPalette());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof FunnelChartConfiguration == false)
return false;
FunnelChartConfiguration other = (FunnelChartConfiguration) obj;
if (other.getFieldWells() == null ^ this.getFieldWells() == null)
return false;
if (other.getFieldWells() != null && other.getFieldWells().equals(this.getFieldWells()) == false)
return false;
if (other.getSortConfiguration() == null ^ this.getSortConfiguration() == null)
return false;
if (other.getSortConfiguration() != null && other.getSortConfiguration().equals(this.getSortConfiguration()) == false)
return false;
if (other.getCategoryLabelOptions() == null ^ this.getCategoryLabelOptions() == null)
return false;
if (other.getCategoryLabelOptions() != null && other.getCategoryLabelOptions().equals(this.getCategoryLabelOptions()) == false)
return false;
if (other.getValueLabelOptions() == null ^ this.getValueLabelOptions() == null)
return false;
if (other.getValueLabelOptions() != null && other.getValueLabelOptions().equals(this.getValueLabelOptions()) == false)
return false;
if (other.getTooltip() == null ^ this.getTooltip() == null)
return false;
if (other.getTooltip() != null && other.getTooltip().equals(this.getTooltip()) == false)
return false;
if (other.getDataLabelOptions() == null ^ this.getDataLabelOptions() == null)
return false;
if (other.getDataLabelOptions() != null && other.getDataLabelOptions().equals(this.getDataLabelOptions()) == false)
return false;
if (other.getVisualPalette() == null ^ this.getVisualPalette() == null)
return false;
if (other.getVisualPalette() != null && other.getVisualPalette().equals(this.getVisualPalette()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFieldWells() == null) ? 0 : getFieldWells().hashCode());
hashCode = prime * hashCode + ((getSortConfiguration() == null) ? 0 : getSortConfiguration().hashCode());
hashCode = prime * hashCode + ((getCategoryLabelOptions() == null) ? 0 : getCategoryLabelOptions().hashCode());
hashCode = prime * hashCode + ((getValueLabelOptions() == null) ? 0 : getValueLabelOptions().hashCode());
hashCode = prime * hashCode + ((getTooltip() == null) ? 0 : getTooltip().hashCode());
hashCode = prime * hashCode + ((getDataLabelOptions() == null) ? 0 : getDataLabelOptions().hashCode());
hashCode = prime * hashCode + ((getVisualPalette() == null) ? 0 : getVisualPalette().hashCode());
return hashCode;
}
@Override
public FunnelChartConfiguration clone() {
try {
return (FunnelChartConfiguration) 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.FunnelChartConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}