Class WordCloudOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WordCloudOptions.Builder,
WordCloudOptions>
The word cloud options for a word cloud visual.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WordCloudOptions.Builder
builder()
final WordCloudCloudLayout
The cloud layout options (fluid, normal) of a word cloud.final String
The cloud layout options (fluid, normal) of a word cloud.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The length limit of each word from 1-100.static Class
<? extends WordCloudOptions.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final WordCloudWordCasing
The word casing options (lower_case, existing_case) for the words in a word cloud.final String
The word casing options (lower_case, existing_case) for the words in a word cloud.final WordCloudWordOrientation
The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.final String
The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.final WordCloudWordPadding
The word padding options (none, small, medium, large) for the words in a word cloud.final String
The word padding options (none, small, medium, large) for the words in a word cloud.final WordCloudWordScaling
The word scaling options (emphasize, normal) for the words in a word cloud.final String
The word scaling options (emphasize, normal) for the words in a word cloud.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnWordCloudWordOrientation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwordOrientationAsString()
.- Returns:
- The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
- See Also:
-
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 returnWordCloudWordOrientation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwordOrientationAsString()
.- Returns:
- The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
- See Also:
-
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 returnWordCloudWordScaling.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwordScalingAsString()
.- Returns:
- The word scaling options (emphasize, normal) for the words in a word cloud.
- See Also:
-
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 returnWordCloudWordScaling.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwordScalingAsString()
.- Returns:
- The word scaling options (emphasize, normal) for the words in a word cloud.
- See Also:
-
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 returnWordCloudCloudLayout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcloudLayoutAsString()
.- Returns:
- The cloud layout options (fluid, normal) of a word cloud.
- See Also:
-
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 returnWordCloudCloudLayout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcloudLayoutAsString()
.- Returns:
- The cloud layout options (fluid, normal) of a word cloud.
- See Also:
-
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 returnWordCloudWordCasing.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwordCasingAsString()
.- Returns:
- The word casing options (lower_case, existing_case) for the words in a word cloud.
- See Also:
-
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 returnWordCloudWordCasing.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwordCasingAsString()
.- Returns:
- The word casing options (lower_case, existing_case) for the words in a word cloud.
- See Also:
-
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 returnWordCloudWordPadding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwordPaddingAsString()
.- Returns:
- The word padding options (none, small, medium, large) for the words in a word cloud.
- See Also:
-
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 returnWordCloudWordPadding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwordPaddingAsString()
.- Returns:
- The word padding options (none, small, medium, large) for the words in a word cloud.
- See Also:
-
maximumStringLength
The length limit of each word from 1-100.
- Returns:
- The length limit of each word from 1-100.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<WordCloudOptions.Builder,
WordCloudOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-