Class VisualMessageConfiguration

java.lang.Object
software.amazon.awssdk.services.quicksight.model.VisualMessageConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VisualMessageConfiguration.Builder,VisualMessageConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class VisualMessageConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VisualMessageConfiguration.Builder,VisualMessageConfiguration>

The configuration for a customizable message displayed on a visual. Supports parameter substitution in text fields.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Specifies whether the custom message is displayed on the visual. When set to true, the custom message appears in place of the default message. When set to false or omitted, the default message is displayed.

      Returns:
      Specifies whether the custom message is displayed on the visual. When set to true, the custom message appears in place of the default message. When set to false or omitted, the default message is displayed.

    • title

      public final String title()

      The title text of the message that is displayed on the visual.

      Returns:
      The title text of the message that is displayed on the visual.

    • titleVisibility

      public final Visibility titleVisibility()

      Specifies whether the title of the message is displayed.

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

      Returns:
      Specifies whether the title of the message is displayed.
      See Also:

    • titleVisibilityAsString

      public final String titleVisibilityAsString()

      Specifies whether the title of the message is displayed.

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

      Returns:
      Specifies whether the title of the message is displayed.
      See Also:

    • description

      public final String description()

      The description text of the message that is displayed on the visual.

      Returns:
      The description text of the message that is displayed on the visual.

    • descriptionVisibility

      public final Visibility descriptionVisibility()

      Specifies whether the description of the message is displayed.

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

      Returns:
      Specifies whether the description of the message is displayed.
      See Also:

    • descriptionVisibilityAsString

      public final String descriptionVisibilityAsString()

      Specifies whether the description of the message is displayed.

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

      Returns:
      Specifies whether the description of the message is displayed.
      See Also:

    • linkText

      public final String linkText()

      The display text of the hyperlink that is shown in the message.

      Returns:
      The display text of the hyperlink that is shown in the message.

    • linkUrl

      public final String linkUrl()

      The destination URL of the hyperlink that is shown in the message. Only valid http, https, and mailto URLs are supported.

      Returns:
      The destination URL of the hyperlink that is shown in the message. Only valid http, https, and mailto URLs are supported.

    • linkVisibility

      public final Visibility linkVisibility()

      Specifies whether the hyperlink in the message is displayed.

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

      Returns:
      Specifies whether the hyperlink in the message is displayed.
      See Also:

    • linkVisibilityAsString

      public final String linkVisibilityAsString()

      Specifies whether the hyperlink in the message is displayed.

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

      Returns:
      Specifies whether the hyperlink in the message is displayed.
      See Also:

    • toBuilder

      public VisualMessageConfiguration.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<VisualMessageConfiguration.Builder,VisualMessageConfiguration>
      Returns:
      a builder for type T

    • builder

      public static VisualMessageConfiguration.Builder builder()

    • serializableBuilderClass

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