Class BarChartSortConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.BarChartSortConfiguration
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BarChartSortConfiguration.Builder,BarChartSortConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class BarChartSortConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BarChartSortConfiguration.Builder,BarChartSortConfiguration>
sort-configuration-description
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BarChartSortConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BarChartSortConfiguration.Builder
builder()
ItemsLimitConfiguration
categoryItemsLimit()
The limit on the number of categories displayed in a bar chart.List<FieldSortOptions>
categorySort()
The sort configuration of category fields.ItemsLimitConfiguration
colorItemsLimit()
The limit on the number of values displayed in a bar chart.List<FieldSortOptions>
colorSort()
The sort configuration of color fields in a bar chart.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasCategorySort()
For responses, this returns true if the service returned a value for the CategorySort property.boolean
hasColorSort()
For responses, this returns true if the service returned a value for the ColorSort property.int
hashCode()
boolean
hasSmallMultiplesSort()
For responses, this returns true if the service returned a value for the SmallMultiplesSort property.List<SdkField<?>>
sdkFields()
static Class<? extends BarChartSortConfiguration.Builder>
serializableBuilderClass()
ItemsLimitConfiguration
smallMultiplesLimitConfiguration()
The limit on the number of small multiples panels that are displayed.List<FieldSortOptions>
smallMultiplesSort()
The sort configuration of the small multiples field.BarChartSortConfiguration.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasCategorySort
public final boolean hasCategorySort()
For responses, this returns true if the service returned a value for the CategorySort property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
categorySort
public final List<FieldSortOptions> categorySort()
The sort configuration of category fields.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCategorySort()
method.- Returns:
- The sort configuration of category fields.
-
categoryItemsLimit
public final ItemsLimitConfiguration categoryItemsLimit()
The limit on the number of categories displayed in a bar chart.
- Returns:
- The limit on the number of categories displayed in a bar chart.
-
hasColorSort
public final boolean hasColorSort()
For responses, this returns true if the service returned a value for the ColorSort property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
colorSort
public final List<FieldSortOptions> colorSort()
The sort configuration of color fields in a bar chart.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasColorSort()
method.- Returns:
- The sort configuration of color fields in a bar chart.
-
colorItemsLimit
public final ItemsLimitConfiguration colorItemsLimit()
The limit on the number of values displayed in a bar chart.
- Returns:
- The limit on the number of values displayed in a bar chart.
-
hasSmallMultiplesSort
public final boolean hasSmallMultiplesSort()
For responses, this returns true if the service returned a value for the SmallMultiplesSort property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
smallMultiplesSort
public final List<FieldSortOptions> smallMultiplesSort()
The sort configuration of the small multiples field.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSmallMultiplesSort()
method.- Returns:
- The sort configuration of the small multiples field.
-
smallMultiplesLimitConfiguration
public final ItemsLimitConfiguration smallMultiplesLimitConfiguration()
The limit on the number of small multiples panels that are displayed.
- Returns:
- The limit on the number of small multiples panels that are displayed.
-
toBuilder
public BarChartSortConfiguration.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<BarChartSortConfiguration.Builder,BarChartSortConfiguration>
-
builder
public static BarChartSortConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends BarChartSortConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
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.
-
-