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

Class WordCloudSortConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.WordCloudSortConfiguration

All Implemented Interfaces:

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

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

The sort configuration of a word cloud visual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WordCloudSortConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static WordCloudSortConfiguration.Builder	builder()
ItemsLimitConfiguration	categoryItemsLimit()	The limit on the number of groups that are displayed in a word cloud.
List<FieldSortOptions>	categorySort()	The sort configuration of group by fields.
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()
List<SdkField<?>>	sdkFields()
static Class<? extends WordCloudSortConfiguration.Builder>	serializableBuilderClass()
WordCloudSortConfiguration.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

categoryItemsLimit

public final ItemsLimitConfiguration categoryItemsLimit()

The limit on the number of groups that are displayed in a word cloud.

Returns:

The limit on the number of groups that are displayed in a word cloud.

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 group by 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 group by fields.

toBuilder

public WordCloudSortConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WordCloudSortConfiguration.Builder,WordCloudSortConfiguration>

builder

public static WordCloudSortConfiguration.Builder builder()

serializableBuilderClass

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