software.amazon.awssdk.services.quicksight.model

Class WordCloudAggregatedFieldWells

java.lang.Object

software.amazon.awssdk.services.quicksight.model.WordCloudAggregatedFieldWells

All Implemented Interfaces:

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

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

The aggregated field wells of a word cloud.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WordCloudAggregatedFieldWells.Builder

Method Summary

Modifier and Type	Method and Description
static WordCloudAggregatedFieldWells.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<DimensionField>	groupBy() The group by field well of a word cloud.
boolean	hasGroupBy() For responses, this returns true if the service returned a value for the GroupBy property.
int	hashCode()
boolean	hasSize() For responses, this returns true if the service returned a value for the Size property.
List<SdkField<?>>	sdkFields()
static Class<? extends WordCloudAggregatedFieldWells.Builder>	serializableBuilderClass()
List<MeasureField>	size() The size field well of a word cloud.
WordCloudAggregatedFieldWells.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

hasGroupBy

public final boolean hasGroupBy()

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

groupBy

public final List<DimensionField> groupBy()

The group by field well of a word cloud. Values are grouped by 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 hasGroupBy() method.

Returns:

The group by field well of a word cloud. Values are grouped by group by fields.

hasSize

public final boolean hasSize()

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

size

public final List<MeasureField> size()

The size field well of a word cloud. Values are aggregated based on 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 hasSize() method.

Returns:

The size field well of a word cloud. Values are aggregated based on group by fields.

toBuilder

public WordCloudAggregatedFieldWells.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WordCloudAggregatedFieldWells.Builder,WordCloudAggregatedFieldWells>

builder

public static WordCloudAggregatedFieldWells.Builder builder()

serializableBuilderClass

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