Class WordCloudOptions

java.lang.Object
software.amazon.awssdk.services.quicksight.model.WordCloudOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WordCloudOptions.Builder,WordCloudOptions>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<WordCloudOptions.Builder,WordCloudOptions>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.