software.amazon.awssdk.services.quicksight.model

Class LineChartSortConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.LineChartSortConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LineChartSortConfiguration.Builder,LineChartSortConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class LineChartSortConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LineChartSortConfiguration.Builder,LineChartSortConfiguration>

The sort configuration of a line chart.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LineChartSortConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static LineChartSortConfiguration.Builder	builder()
ItemsLimitConfiguration	categoryItemsLimitConfiguration() The limit on the number of categories that are displayed in a line chart.
List<FieldSortOptions>	categorySort() The sort configuration of the category fields.
ItemsLimitConfiguration	colorItemsLimitConfiguration() The limit on the number of lines that are displayed in a line 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.
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 LineChartSortConfiguration.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.
LineChartSortConfiguration.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 the isEmpty() 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 the 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 the category fields.

categoryItemsLimitConfiguration

public final ItemsLimitConfiguration categoryItemsLimitConfiguration()

The limit on the number of categories that are displayed in a line chart.

Returns:

The limit on the number of categories that are displayed in a line chart.

colorItemsLimitConfiguration

public final ItemsLimitConfiguration colorItemsLimitConfiguration()

The limit on the number of lines that are displayed in a line chart.

Returns:

The limit on the number of lines that are displayed in a line 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 the isEmpty() 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 LineChartSortConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LineChartSortConfiguration.Builder,LineChartSortConfiguration>

builder

public static LineChartSortConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends LineChartSortConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo