com.amazonaws.services.quicksight.model.BarChartSortConfiguration 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;
/**
*
* sort-configuration-description
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class BarChartSortConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The sort configuration of category fields.
*
*/
private java.util.List categorySort;
/**
*
* The limit on the number of categories displayed in a bar chart.
*
*/
private ItemsLimitConfiguration categoryItemsLimit;
/**
*
* The sort configuration of color fields in a bar chart.
*
*/
private java.util.List colorSort;
/**
*
* The limit on the number of values displayed in a bar chart.
*
*/
private ItemsLimitConfiguration colorItemsLimit;
/**
*
* The sort configuration of the small multiples field.
*
*/
private java.util.List smallMultiplesSort;
/**
*
* The limit on the number of small multiples panels that are displayed.
*
*/
private ItemsLimitConfiguration smallMultiplesLimitConfiguration;
/**
*
* The sort configuration of category fields.
*
*
* @return The sort configuration of category fields.
*/
public java.util.List getCategorySort() {
return categorySort;
}
/**
*
* The sort configuration of category fields.
*
*
* @param categorySort
* The sort configuration of category fields.
*/
public void setCategorySort(java.util.Collection categorySort) {
if (categorySort == null) {
this.categorySort = null;
return;
}
this.categorySort = new java.util.ArrayList(categorySort);
}
/**
*
* The sort configuration of category fields.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCategorySort(java.util.Collection)} or {@link #withCategorySort(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param categorySort
* The sort configuration of category fields.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withCategorySort(FieldSortOptions... categorySort) {
if (this.categorySort == null) {
setCategorySort(new java.util.ArrayList(categorySort.length));
}
for (FieldSortOptions ele : categorySort) {
this.categorySort.add(ele);
}
return this;
}
/**
*
* The sort configuration of category fields.
*
*
* @param categorySort
* The sort configuration of category fields.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withCategorySort(java.util.Collection categorySort) {
setCategorySort(categorySort);
return this;
}
/**
*
* The limit on the number of categories displayed in a bar chart.
*
*
* @param categoryItemsLimit
* The limit on the number of categories displayed in a bar chart.
*/
public void setCategoryItemsLimit(ItemsLimitConfiguration categoryItemsLimit) {
this.categoryItemsLimit = categoryItemsLimit;
}
/**
*
* The limit on the number of categories displayed in a bar chart.
*
*
* @return The limit on the number of categories displayed in a bar chart.
*/
public ItemsLimitConfiguration getCategoryItemsLimit() {
return this.categoryItemsLimit;
}
/**
*
* The limit on the number of categories displayed in a bar chart.
*
*
* @param categoryItemsLimit
* The limit on the number of categories displayed in a bar chart.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withCategoryItemsLimit(ItemsLimitConfiguration categoryItemsLimit) {
setCategoryItemsLimit(categoryItemsLimit);
return this;
}
/**
*
* The sort configuration of color fields in a bar chart.
*
*
* @return The sort configuration of color fields in a bar chart.
*/
public java.util.List getColorSort() {
return colorSort;
}
/**
*
* The sort configuration of color fields in a bar chart.
*
*
* @param colorSort
* The sort configuration of color fields in a bar chart.
*/
public void setColorSort(java.util.Collection colorSort) {
if (colorSort == null) {
this.colorSort = null;
return;
}
this.colorSort = new java.util.ArrayList(colorSort);
}
/**
*
* The sort configuration of color fields in a bar chart.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setColorSort(java.util.Collection)} or {@link #withColorSort(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param colorSort
* The sort configuration of color fields in a bar chart.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withColorSort(FieldSortOptions... colorSort) {
if (this.colorSort == null) {
setColorSort(new java.util.ArrayList(colorSort.length));
}
for (FieldSortOptions ele : colorSort) {
this.colorSort.add(ele);
}
return this;
}
/**
*
* The sort configuration of color fields in a bar chart.
*
*
* @param colorSort
* The sort configuration of color fields in a bar chart.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withColorSort(java.util.Collection colorSort) {
setColorSort(colorSort);
return this;
}
/**
*
* The limit on the number of values displayed in a bar chart.
*
*
* @param colorItemsLimit
* The limit on the number of values displayed in a bar chart.
*/
public void setColorItemsLimit(ItemsLimitConfiguration colorItemsLimit) {
this.colorItemsLimit = colorItemsLimit;
}
/**
*
* The limit on the number of values displayed in a bar chart.
*
*
* @return The limit on the number of values displayed in a bar chart.
*/
public ItemsLimitConfiguration getColorItemsLimit() {
return this.colorItemsLimit;
}
/**
*
* The limit on the number of values displayed in a bar chart.
*
*
* @param colorItemsLimit
* The limit on the number of values displayed in a bar chart.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withColorItemsLimit(ItemsLimitConfiguration colorItemsLimit) {
setColorItemsLimit(colorItemsLimit);
return this;
}
/**
*
* The sort configuration of the small multiples field.
*
*
* @return The sort configuration of the small multiples field.
*/
public java.util.List getSmallMultiplesSort() {
return smallMultiplesSort;
}
/**
*
* The sort configuration of the small multiples field.
*
*
* @param smallMultiplesSort
* The sort configuration of the small multiples field.
*/
public void setSmallMultiplesSort(java.util.Collection smallMultiplesSort) {
if (smallMultiplesSort == null) {
this.smallMultiplesSort = null;
return;
}
this.smallMultiplesSort = new java.util.ArrayList(smallMultiplesSort);
}
/**
*
* The sort configuration of the small multiples field.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSmallMultiplesSort(java.util.Collection)} or {@link #withSmallMultiplesSort(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param smallMultiplesSort
* The sort configuration of the small multiples field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withSmallMultiplesSort(FieldSortOptions... smallMultiplesSort) {
if (this.smallMultiplesSort == null) {
setSmallMultiplesSort(new java.util.ArrayList(smallMultiplesSort.length));
}
for (FieldSortOptions ele : smallMultiplesSort) {
this.smallMultiplesSort.add(ele);
}
return this;
}
/**
*
* The sort configuration of the small multiples field.
*
*
* @param smallMultiplesSort
* The sort configuration of the small multiples field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withSmallMultiplesSort(java.util.Collection smallMultiplesSort) {
setSmallMultiplesSort(smallMultiplesSort);
return this;
}
/**
*
* The limit on the number of small multiples panels that are displayed.
*
*
* @param smallMultiplesLimitConfiguration
* The limit on the number of small multiples panels that are displayed.
*/
public void setSmallMultiplesLimitConfiguration(ItemsLimitConfiguration smallMultiplesLimitConfiguration) {
this.smallMultiplesLimitConfiguration = smallMultiplesLimitConfiguration;
}
/**
*
* The limit on the number of small multiples panels that are displayed.
*
*
* @return The limit on the number of small multiples panels that are displayed.
*/
public ItemsLimitConfiguration getSmallMultiplesLimitConfiguration() {
return this.smallMultiplesLimitConfiguration;
}
/**
*
* The limit on the number of small multiples panels that are displayed.
*
*
* @param smallMultiplesLimitConfiguration
* The limit on the number of small multiples panels that are displayed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public BarChartSortConfiguration withSmallMultiplesLimitConfiguration(ItemsLimitConfiguration smallMultiplesLimitConfiguration) {
setSmallMultiplesLimitConfiguration(smallMultiplesLimitConfiguration);
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 (getCategorySort() != null)
sb.append("CategorySort: ").append(getCategorySort()).append(",");
if (getCategoryItemsLimit() != null)
sb.append("CategoryItemsLimit: ").append(getCategoryItemsLimit()).append(",");
if (getColorSort() != null)
sb.append("ColorSort: ").append(getColorSort()).append(",");
if (getColorItemsLimit() != null)
sb.append("ColorItemsLimit: ").append(getColorItemsLimit()).append(",");
if (getSmallMultiplesSort() != null)
sb.append("SmallMultiplesSort: ").append(getSmallMultiplesSort()).append(",");
if (getSmallMultiplesLimitConfiguration() != null)
sb.append("SmallMultiplesLimitConfiguration: ").append(getSmallMultiplesLimitConfiguration());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof BarChartSortConfiguration == false)
return false;
BarChartSortConfiguration other = (BarChartSortConfiguration) obj;
if (other.getCategorySort() == null ^ this.getCategorySort() == null)
return false;
if (other.getCategorySort() != null && other.getCategorySort().equals(this.getCategorySort()) == false)
return false;
if (other.getCategoryItemsLimit() == null ^ this.getCategoryItemsLimit() == null)
return false;
if (other.getCategoryItemsLimit() != null && other.getCategoryItemsLimit().equals(this.getCategoryItemsLimit()) == false)
return false;
if (other.getColorSort() == null ^ this.getColorSort() == null)
return false;
if (other.getColorSort() != null && other.getColorSort().equals(this.getColorSort()) == false)
return false;
if (other.getColorItemsLimit() == null ^ this.getColorItemsLimit() == null)
return false;
if (other.getColorItemsLimit() != null && other.getColorItemsLimit().equals(this.getColorItemsLimit()) == false)
return false;
if (other.getSmallMultiplesSort() == null ^ this.getSmallMultiplesSort() == null)
return false;
if (other.getSmallMultiplesSort() != null && other.getSmallMultiplesSort().equals(this.getSmallMultiplesSort()) == false)
return false;
if (other.getSmallMultiplesLimitConfiguration() == null ^ this.getSmallMultiplesLimitConfiguration() == null)
return false;
if (other.getSmallMultiplesLimitConfiguration() != null
&& other.getSmallMultiplesLimitConfiguration().equals(this.getSmallMultiplesLimitConfiguration()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCategorySort() == null) ? 0 : getCategorySort().hashCode());
hashCode = prime * hashCode + ((getCategoryItemsLimit() == null) ? 0 : getCategoryItemsLimit().hashCode());
hashCode = prime * hashCode + ((getColorSort() == null) ? 0 : getColorSort().hashCode());
hashCode = prime * hashCode + ((getColorItemsLimit() == null) ? 0 : getColorItemsLimit().hashCode());
hashCode = prime * hashCode + ((getSmallMultiplesSort() == null) ? 0 : getSmallMultiplesSort().hashCode());
hashCode = prime * hashCode + ((getSmallMultiplesLimitConfiguration() == null) ? 0 : getSmallMultiplesLimitConfiguration().hashCode());
return hashCode;
}
@Override
public BarChartSortConfiguration clone() {
try {
return (BarChartSortConfiguration) 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.BarChartSortConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}