com.amazonaws.services.quicksight.model.PieChartConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-quicksight Show documentation
Show all versions of aws-java-sdk-quicksight Show documentation
The AWS Java SDK for Amazon QuickSight module holds the client classes that are used for communicating with Amazon QuickSight Service
The newest version!
/*
* 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;
/**
*
* The configuration of a pie chart.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PieChartConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The field wells of the visual.
*
*/
private PieChartFieldWells fieldWells;
/**
*
* The sort configuration of a pie chart.
*
*/
private PieChartSortConfiguration sortConfiguration;
/**
*
* The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a
* donut chart.
*
*/
private DonutOptions donutOptions;
/**
*
* The small multiples setup for the visual.
*
*/
private SmallMultiplesOptions smallMultiplesOptions;
/**
*
* The label options of the group/color that is displayed in a pie chart.
*
*/
private ChartAxisLabelOptions categoryLabelOptions;
/**
*
* The label options for the value that is displayed in a pie chart.
*
*/
private ChartAxisLabelOptions valueLabelOptions;
/**
*
* The legend display setup of the visual.
*
*/
private LegendOptions legend;
/**
*
* The options that determine if visual data labels are displayed.
*
*/
private DataLabelOptions dataLabels;
/**
*
* The tooltip display setup of the visual.
*
*/
private TooltipOptions tooltip;
/**
*
* The palette (chart color) display setup of the visual.
*
*/
private VisualPalette visualPalette;
/**
*
* The contribution analysis (anomaly configuration) setup of the visual.
*
*/
private java.util.List contributionAnalysisDefaults;
/**
*
* The general visual interactions setup for a visual.
*
*/
private VisualInteractionOptions interactions;
/**
*
* The field wells of the visual.
*
*
* @param fieldWells
* The field wells of the visual.
*/
public void setFieldWells(PieChartFieldWells fieldWells) {
this.fieldWells = fieldWells;
}
/**
*
* The field wells of the visual.
*
*
* @return The field wells of the visual.
*/
public PieChartFieldWells getFieldWells() {
return this.fieldWells;
}
/**
*
* The field wells of the visual.
*
*
* @param fieldWells
* The field wells of the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withFieldWells(PieChartFieldWells fieldWells) {
setFieldWells(fieldWells);
return this;
}
/**
*
* The sort configuration of a pie chart.
*
*
* @param sortConfiguration
* The sort configuration of a pie chart.
*/
public void setSortConfiguration(PieChartSortConfiguration sortConfiguration) {
this.sortConfiguration = sortConfiguration;
}
/**
*
* The sort configuration of a pie chart.
*
*
* @return The sort configuration of a pie chart.
*/
public PieChartSortConfiguration getSortConfiguration() {
return this.sortConfiguration;
}
/**
*
* The sort configuration of a pie chart.
*
*
* @param sortConfiguration
* The sort configuration of a pie chart.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withSortConfiguration(PieChartSortConfiguration sortConfiguration) {
setSortConfiguration(sortConfiguration);
return this;
}
/**
*
* The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a
* donut chart.
*
*
* @param donutOptions
* The options that determine the shape of the chart. This option determines whether the chart is a pie chart
* or a donut chart.
*/
public void setDonutOptions(DonutOptions donutOptions) {
this.donutOptions = donutOptions;
}
/**
*
* The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a
* donut chart.
*
*
* @return The options that determine the shape of the chart. This option determines whether the chart is a pie
* chart or a donut chart.
*/
public DonutOptions getDonutOptions() {
return this.donutOptions;
}
/**
*
* The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a
* donut chart.
*
*
* @param donutOptions
* The options that determine the shape of the chart. This option determines whether the chart is a pie chart
* or a donut chart.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withDonutOptions(DonutOptions donutOptions) {
setDonutOptions(donutOptions);
return this;
}
/**
*
* The small multiples setup for the visual.
*
*
* @param smallMultiplesOptions
* The small multiples setup for the visual.
*/
public void setSmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions) {
this.smallMultiplesOptions = smallMultiplesOptions;
}
/**
*
* The small multiples setup for the visual.
*
*
* @return The small multiples setup for the visual.
*/
public SmallMultiplesOptions getSmallMultiplesOptions() {
return this.smallMultiplesOptions;
}
/**
*
* The small multiples setup for the visual.
*
*
* @param smallMultiplesOptions
* The small multiples setup for the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withSmallMultiplesOptions(SmallMultiplesOptions smallMultiplesOptions) {
setSmallMultiplesOptions(smallMultiplesOptions);
return this;
}
/**
*
* The label options of the group/color that is displayed in a pie chart.
*
*
* @param categoryLabelOptions
* The label options of the group/color that is displayed in a pie chart.
*/
public void setCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) {
this.categoryLabelOptions = categoryLabelOptions;
}
/**
*
* The label options of the group/color that is displayed in a pie chart.
*
*
* @return The label options of the group/color that is displayed in a pie chart.
*/
public ChartAxisLabelOptions getCategoryLabelOptions() {
return this.categoryLabelOptions;
}
/**
*
* The label options of the group/color that is displayed in a pie chart.
*
*
* @param categoryLabelOptions
* The label options of the group/color that is displayed in a pie chart.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withCategoryLabelOptions(ChartAxisLabelOptions categoryLabelOptions) {
setCategoryLabelOptions(categoryLabelOptions);
return this;
}
/**
*
* The label options for the value that is displayed in a pie chart.
*
*
* @param valueLabelOptions
* The label options for the value that is displayed in a pie chart.
*/
public void setValueLabelOptions(ChartAxisLabelOptions valueLabelOptions) {
this.valueLabelOptions = valueLabelOptions;
}
/**
*
* The label options for the value that is displayed in a pie chart.
*
*
* @return The label options for the value that is displayed in a pie chart.
*/
public ChartAxisLabelOptions getValueLabelOptions() {
return this.valueLabelOptions;
}
/**
*
* The label options for the value that is displayed in a pie chart.
*
*
* @param valueLabelOptions
* The label options for the value that is displayed in a pie chart.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withValueLabelOptions(ChartAxisLabelOptions valueLabelOptions) {
setValueLabelOptions(valueLabelOptions);
return this;
}
/**
*
* The legend display setup of the visual.
*
*
* @param legend
* The legend display setup of the visual.
*/
public void setLegend(LegendOptions legend) {
this.legend = legend;
}
/**
*
* The legend display setup of the visual.
*
*
* @return The legend display setup of the visual.
*/
public LegendOptions getLegend() {
return this.legend;
}
/**
*
* The legend display setup of the visual.
*
*
* @param legend
* The legend display setup of the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withLegend(LegendOptions legend) {
setLegend(legend);
return this;
}
/**
*
* The options that determine if visual data labels are displayed.
*
*
* @param dataLabels
* The options that determine if visual data labels are displayed.
*/
public void setDataLabels(DataLabelOptions dataLabels) {
this.dataLabels = dataLabels;
}
/**
*
* The options that determine if visual data labels are displayed.
*
*
* @return The options that determine if visual data labels are displayed.
*/
public DataLabelOptions getDataLabels() {
return this.dataLabels;
}
/**
*
* The options that determine if visual data labels are displayed.
*
*
* @param dataLabels
* The options that determine if visual data labels are displayed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withDataLabels(DataLabelOptions dataLabels) {
setDataLabels(dataLabels);
return this;
}
/**
*
* The tooltip display setup of the visual.
*
*
* @param tooltip
* The tooltip display setup of the visual.
*/
public void setTooltip(TooltipOptions tooltip) {
this.tooltip = tooltip;
}
/**
*
* The tooltip display setup of the visual.
*
*
* @return The tooltip display setup of the visual.
*/
public TooltipOptions getTooltip() {
return this.tooltip;
}
/**
*
* The tooltip display setup of the visual.
*
*
* @param tooltip
* The tooltip display setup of the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withTooltip(TooltipOptions tooltip) {
setTooltip(tooltip);
return this;
}
/**
*
* The palette (chart color) display setup of the visual.
*
*
* @param visualPalette
* The palette (chart color) display setup of the visual.
*/
public void setVisualPalette(VisualPalette visualPalette) {
this.visualPalette = visualPalette;
}
/**
*
* The palette (chart color) display setup of the visual.
*
*
* @return The palette (chart color) display setup of the visual.
*/
public VisualPalette getVisualPalette() {
return this.visualPalette;
}
/**
*
* The palette (chart color) display setup of the visual.
*
*
* @param visualPalette
* The palette (chart color) display setup of the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withVisualPalette(VisualPalette visualPalette) {
setVisualPalette(visualPalette);
return this;
}
/**
*
* The contribution analysis (anomaly configuration) setup of the visual.
*
*
* @return The contribution analysis (anomaly configuration) setup of the visual.
*/
public java.util.List getContributionAnalysisDefaults() {
return contributionAnalysisDefaults;
}
/**
*
* The contribution analysis (anomaly configuration) setup of the visual.
*
*
* @param contributionAnalysisDefaults
* The contribution analysis (anomaly configuration) setup of the visual.
*/
public void setContributionAnalysisDefaults(java.util.Collection contributionAnalysisDefaults) {
if (contributionAnalysisDefaults == null) {
this.contributionAnalysisDefaults = null;
return;
}
this.contributionAnalysisDefaults = new java.util.ArrayList(contributionAnalysisDefaults);
}
/**
*
* The contribution analysis (anomaly configuration) setup of the visual.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setContributionAnalysisDefaults(java.util.Collection)} or
* {@link #withContributionAnalysisDefaults(java.util.Collection)} if you want to override the existing values.
*
*
* @param contributionAnalysisDefaults
* The contribution analysis (anomaly configuration) setup of the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withContributionAnalysisDefaults(ContributionAnalysisDefault... contributionAnalysisDefaults) {
if (this.contributionAnalysisDefaults == null) {
setContributionAnalysisDefaults(new java.util.ArrayList(contributionAnalysisDefaults.length));
}
for (ContributionAnalysisDefault ele : contributionAnalysisDefaults) {
this.contributionAnalysisDefaults.add(ele);
}
return this;
}
/**
*
* The contribution analysis (anomaly configuration) setup of the visual.
*
*
* @param contributionAnalysisDefaults
* The contribution analysis (anomaly configuration) setup of the visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withContributionAnalysisDefaults(java.util.Collection contributionAnalysisDefaults) {
setContributionAnalysisDefaults(contributionAnalysisDefaults);
return this;
}
/**
*
* The general visual interactions setup for a visual.
*
*
* @param interactions
* The general visual interactions setup for a visual.
*/
public void setInteractions(VisualInteractionOptions interactions) {
this.interactions = interactions;
}
/**
*
* The general visual interactions setup for a visual.
*
*
* @return The general visual interactions setup for a visual.
*/
public VisualInteractionOptions getInteractions() {
return this.interactions;
}
/**
*
* The general visual interactions setup for a visual.
*
*
* @param interactions
* The general visual interactions setup for a visual.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PieChartConfiguration withInteractions(VisualInteractionOptions interactions) {
setInteractions(interactions);
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 (getDonutOptions() != null)
sb.append("DonutOptions: ").append(getDonutOptions()).append(",");
if (getSmallMultiplesOptions() != null)
sb.append("SmallMultiplesOptions: ").append(getSmallMultiplesOptions()).append(",");
if (getCategoryLabelOptions() != null)
sb.append("CategoryLabelOptions: ").append(getCategoryLabelOptions()).append(",");
if (getValueLabelOptions() != null)
sb.append("ValueLabelOptions: ").append(getValueLabelOptions()).append(",");
if (getLegend() != null)
sb.append("Legend: ").append(getLegend()).append(",");
if (getDataLabels() != null)
sb.append("DataLabels: ").append(getDataLabels()).append(",");
if (getTooltip() != null)
sb.append("Tooltip: ").append(getTooltip()).append(",");
if (getVisualPalette() != null)
sb.append("VisualPalette: ").append(getVisualPalette()).append(",");
if (getContributionAnalysisDefaults() != null)
sb.append("ContributionAnalysisDefaults: ").append(getContributionAnalysisDefaults()).append(",");
if (getInteractions() != null)
sb.append("Interactions: ").append(getInteractions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PieChartConfiguration == false)
return false;
PieChartConfiguration other = (PieChartConfiguration) 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.getDonutOptions() == null ^ this.getDonutOptions() == null)
return false;
if (other.getDonutOptions() != null && other.getDonutOptions().equals(this.getDonutOptions()) == false)
return false;
if (other.getSmallMultiplesOptions() == null ^ this.getSmallMultiplesOptions() == null)
return false;
if (other.getSmallMultiplesOptions() != null && other.getSmallMultiplesOptions().equals(this.getSmallMultiplesOptions()) == 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.getLegend() == null ^ this.getLegend() == null)
return false;
if (other.getLegend() != null && other.getLegend().equals(this.getLegend()) == false)
return false;
if (other.getDataLabels() == null ^ this.getDataLabels() == null)
return false;
if (other.getDataLabels() != null && other.getDataLabels().equals(this.getDataLabels()) == 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.getVisualPalette() == null ^ this.getVisualPalette() == null)
return false;
if (other.getVisualPalette() != null && other.getVisualPalette().equals(this.getVisualPalette()) == false)
return false;
if (other.getContributionAnalysisDefaults() == null ^ this.getContributionAnalysisDefaults() == null)
return false;
if (other.getContributionAnalysisDefaults() != null && other.getContributionAnalysisDefaults().equals(this.getContributionAnalysisDefaults()) == false)
return false;
if (other.getInteractions() == null ^ this.getInteractions() == null)
return false;
if (other.getInteractions() != null && other.getInteractions().equals(this.getInteractions()) == 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 + ((getDonutOptions() == null) ? 0 : getDonutOptions().hashCode());
hashCode = prime * hashCode + ((getSmallMultiplesOptions() == null) ? 0 : getSmallMultiplesOptions().hashCode());
hashCode = prime * hashCode + ((getCategoryLabelOptions() == null) ? 0 : getCategoryLabelOptions().hashCode());
hashCode = prime * hashCode + ((getValueLabelOptions() == null) ? 0 : getValueLabelOptions().hashCode());
hashCode = prime * hashCode + ((getLegend() == null) ? 0 : getLegend().hashCode());
hashCode = prime * hashCode + ((getDataLabels() == null) ? 0 : getDataLabels().hashCode());
hashCode = prime * hashCode + ((getTooltip() == null) ? 0 : getTooltip().hashCode());
hashCode = prime * hashCode + ((getVisualPalette() == null) ? 0 : getVisualPalette().hashCode());
hashCode = prime * hashCode + ((getContributionAnalysisDefaults() == null) ? 0 : getContributionAnalysisDefaults().hashCode());
hashCode = prime * hashCode + ((getInteractions() == null) ? 0 : getInteractions().hashCode());
return hashCode;
}
@Override
public PieChartConfiguration clone() {
try {
return (PieChartConfiguration) 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.PieChartConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy