software.amazon.awssdk.services.quicksight.model

Class WordCloudOptions

java.lang.Object

software.amazon.awssdk.services.quicksight.model.WordCloudOptions

All Implemented Interfaces:

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

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

The word cloud options for a word cloud visual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WordCloudOptions.Builder

Method Summary

Modifier and Type	Method and Description
static WordCloudOptions.Builder	builder()
WordCloudCloudLayout	cloudLayout() The cloud layout options (fluid, normal) of a word cloud.
String	cloudLayoutAsString() The cloud layout options (fluid, normal) of a word cloud.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maximumStringLength() The length limit of each word from 1-100.
List<SdkField<?>>	sdkFields()
static Class<? extends WordCloudOptions.Builder>	serializableBuilderClass()
WordCloudOptions.Builder	toBuilder()
String	toString() Returns a string representation of this object.
WordCloudWordCasing	wordCasing() The word casing options (lower_case, existing_case) for the words in a word cloud.
String	wordCasingAsString() The word casing options (lower_case, existing_case) for the words in a word cloud.
WordCloudWordOrientation	wordOrientation() The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
String	wordOrientationAsString() The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
WordCloudWordPadding	wordPadding() The word padding options (none, small, medium, large) for the words in a word cloud.
String	wordPaddingAsString() The word padding options (none, small, medium, large) for the words in a word cloud.
WordCloudWordScaling	wordScaling() The word scaling options (emphasize, normal) for the words in a word cloud.
String	wordScalingAsString() The word scaling options (emphasize, normal) for the words in a word cloud.

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

wordOrientation

public final WordCloudWordOrientation wordOrientation()

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

If the service returns an enum value that is not available in the current SDK version, wordOrientation will return WordCloudWordOrientation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wordOrientationAsString().

Returns:

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

See Also:

WordCloudWordOrientation

wordOrientationAsString

public final String wordOrientationAsString()

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

If the service returns an enum value that is not available in the current SDK version, wordOrientation will return WordCloudWordOrientation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wordOrientationAsString().

Returns:

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

See Also:

WordCloudWordOrientation

wordScaling

public final WordCloudWordScaling wordScaling()

The word scaling options (emphasize, normal) for the words in a word cloud.

If the service returns an enum value that is not available in the current SDK version, wordScaling will return WordCloudWordScaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wordScalingAsString().

Returns:

The word scaling options (emphasize, normal) for the words in a word cloud.

See Also:

WordCloudWordScaling

wordScalingAsString

public final String wordScalingAsString()

The word scaling options (emphasize, normal) for the words in a word cloud.

If the service returns an enum value that is not available in the current SDK version, wordScaling will return WordCloudWordScaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wordScalingAsString().

Returns:

The word scaling options (emphasize, normal) for the words in a word cloud.

See Also:

WordCloudWordScaling

cloudLayout

public final WordCloudCloudLayout cloudLayout()

The cloud layout options (fluid, normal) of a word cloud.

If the service returns an enum value that is not available in the current SDK version, cloudLayout will return WordCloudCloudLayout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cloudLayoutAsString().

Returns:

The cloud layout options (fluid, normal) of a word cloud.

See Also:

WordCloudCloudLayout

cloudLayoutAsString

public final String cloudLayoutAsString()

The cloud layout options (fluid, normal) of a word cloud.

If the service returns an enum value that is not available in the current SDK version, cloudLayout will return WordCloudCloudLayout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cloudLayoutAsString().

Returns:

The cloud layout options (fluid, normal) of a word cloud.

See Also:

WordCloudCloudLayout

wordCasing

public final WordCloudWordCasing wordCasing()

The word casing options (lower_case, existing_case) for the words in a word cloud.

If the service returns an enum value that is not available in the current SDK version, wordCasing will return WordCloudWordCasing.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wordCasingAsString().

Returns:

The word casing options (lower_case, existing_case) for the words in a word cloud.

See Also:

WordCloudWordCasing

wordCasingAsString

public final String wordCasingAsString()

The word casing options (lower_case, existing_case) for the words in a word cloud.

If the service returns an enum value that is not available in the current SDK version, wordCasing will return WordCloudWordCasing.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wordCasingAsString().

Returns:

The word casing options (lower_case, existing_case) for the words in a word cloud.

See Also:

WordCloudWordCasing

wordPadding

public final WordCloudWordPadding wordPadding()

The word padding options (none, small, medium, large) for the words in a word cloud.

If the service returns an enum value that is not available in the current SDK version, wordPadding will return WordCloudWordPadding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wordPaddingAsString().

Returns:

The word padding options (none, small, medium, large) for the words in a word cloud.

See Also:

WordCloudWordPadding

wordPaddingAsString

public final String wordPaddingAsString()

The word padding options (none, small, medium, large) for the words in a word cloud.

If the service returns an enum value that is not available in the current SDK version, wordPadding will return WordCloudWordPadding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from wordPaddingAsString().

Returns:

The word padding options (none, small, medium, large) for the words in a word cloud.

See Also:

WordCloudWordPadding

maximumStringLength

public final Integer maximumStringLength()

The length limit of each word from 1-100.

Returns:

The length limit of each word from 1-100.

toBuilder

public WordCloudOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WordCloudOptions.Builder,WordCloudOptions>

builder

public static WordCloudOptions.Builder builder()

serializableBuilderClass

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