Class TooltipOptions

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

The display options for the visual tooltip.

See Also:

  • Method Details

    • tooltipVisibility

      public final Visibility tooltipVisibility()

      Determines whether or not the tooltip is visible.

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

      Returns:
      Determines whether or not the tooltip is visible.
      See Also:

    • tooltipVisibilityAsString

      public final String tooltipVisibilityAsString()

      Determines whether or not the tooltip is visible.

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

      Returns:
      Determines whether or not the tooltip is visible.
      See Also:

    • selectedTooltipType

      public final SelectedTooltipType selectedTooltipType()

      The selected type for the tooltip. Choose one of the following options:

      • BASIC: A basic tooltip.

      • DETAILED: A detailed tooltip.

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

      Returns:
      The selected type for the tooltip. Choose one of the following options:

      • BASIC: A basic tooltip.

      • DETAILED: A detailed tooltip.

      See Also:

    • selectedTooltipTypeAsString

      public final String selectedTooltipTypeAsString()

      The selected type for the tooltip. Choose one of the following options:

      • BASIC: A basic tooltip.

      • DETAILED: A detailed tooltip.

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

      Returns:
      The selected type for the tooltip. Choose one of the following options:

      • BASIC: A basic tooltip.

      • DETAILED: A detailed tooltip.

      See Also:

    • fieldBasedTooltip

      public final FieldBasedTooltip fieldBasedTooltip()

      The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

      Returns:
      The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

    • toBuilder

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

    • builder

      public static TooltipOptions.Builder builder()

    • serializableBuilderClass

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