Class TooltipSheetDefinition

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

A tooltip sheet is an object that contains a set of visuals that are used as a tooltip. Every analysis and dashboard must contain at least one non-tooltip sheet.

See Also:

  • Method Details

    • sheetId

      public final String sheetId()

      The unique identifier of a tooltip sheet.

      Returns:
      The unique identifier of a tooltip sheet.

    • name

      public final String name()

      The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick console.

      Returns:
      The name of the tooltip sheet. This name is displayed on the sheet's tab in the Quick console.

    • hasVisuals

      public final boolean hasVisuals()
      For responses, this returns true if the service returned a value for the Visuals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • visuals

      public final List<Visual> visuals()

      A list of the visuals that are on a tooltip sheet.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVisuals() method.

      Returns:
      A list of the visuals that are on a tooltip sheet.

    • hasTextBoxes

      public final boolean hasTextBoxes()
      For responses, this returns true if the service returned a value for the TextBoxes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • textBoxes

      public final List<SheetTextBox> textBoxes()

      The text boxes that are on a tooltip sheet.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTextBoxes() method.

      Returns:
      The text boxes that are on a tooltip sheet.

    • hasImages

      public final boolean hasImages()
      For responses, this returns true if the service returned a value for the Images property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • images

      public final List<SheetImage> images()

      A list of images on a tooltip sheet.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasImages() method.

      Returns:
      A list of images on a tooltip sheet.

    • hasLayouts

      public final boolean hasLayouts()
      For responses, this returns true if the service returned a value for the Layouts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • layouts

      public final List<Layout> layouts()

      Layouts define how the components of a tooltip sheet are arranged.

      For more information, see Types of layout in the Amazon Quick Suite User Guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLayouts() method.

      Returns:
      Layouts define how the components of a tooltip sheet are arranged.

      For more information, see Types of layout in the Amazon Quick Suite User Guide.

    • toBuilder

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

    • builder

      public static TooltipSheetDefinition.Builder builder()

    • serializableBuilderClass

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