Package software.amazon.awssdk.services.quicksight.model

Class HeatMapSortConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.HeatMapSortConfiguration

All Implemented Interfaces:

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

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

The sort configuration of a heat map.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HeatMapSortConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static HeatMapSortConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHeatMapColumnSort()	For responses, this returns true if the service returned a value for the HeatMapColumnSort property.
boolean	hasHeatMapRowSort()	For responses, this returns true if the service returned a value for the HeatMapRowSort property.
ItemsLimitConfiguration	heatMapColumnItemsLimitConfiguration()	The limit on the number of columns that are displayed in a heat map.
List<FieldSortOptions>	heatMapColumnSort()	The column sort configuration for heat map for columns that aren't a part of a field well.
ItemsLimitConfiguration	heatMapRowItemsLimitConfiguration()	The limit on the number of rows that are displayed in a heat map.
List<FieldSortOptions>	heatMapRowSort()	The field sort configuration of the rows fields.
List<SdkField<?>>	sdkFields()
static Class<? extends HeatMapSortConfiguration.Builder>	serializableBuilderClass()
HeatMapSortConfiguration.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

hasHeatMapRowSort

public final boolean hasHeatMapRowSort()

For responses, this returns true if the service returned a value for the HeatMapRowSort 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.

heatMapRowSort

public final List<FieldSortOptions> heatMapRowSort()

The field sort configuration of the rows 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 hasHeatMapRowSort() method.

Returns:

The field sort configuration of the rows fields.

hasHeatMapColumnSort

public final boolean hasHeatMapColumnSort()

For responses, this returns true if the service returned a value for the HeatMapColumnSort 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.

heatMapColumnSort

public final List<FieldSortOptions> heatMapColumnSort()

The column sort configuration for heat map for columns that aren't a part of a field well.

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 hasHeatMapColumnSort() method.

Returns:

The column sort configuration for heat map for columns that aren't a part of a field well.

heatMapRowItemsLimitConfiguration

public final ItemsLimitConfiguration heatMapRowItemsLimitConfiguration()

The limit on the number of rows that are displayed in a heat map.

Returns:

The limit on the number of rows that are displayed in a heat map.

heatMapColumnItemsLimitConfiguration

public final ItemsLimitConfiguration heatMapColumnItemsLimitConfiguration()

The limit on the number of columns that are displayed in a heat map.

Returns:

The limit on the number of columns that are displayed in a heat map.

toBuilder

public HeatMapSortConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HeatMapSortConfiguration.Builder,HeatMapSortConfiguration>

builder

public static HeatMapSortConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends HeatMapSortConfiguration.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