Class FieldTooltipItem

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

The tooltip item for the fields.

See Also:

  • Method Details

    • fieldId

      public final String fieldId()

      The unique ID of the field that is targeted by the tooltip.

      Returns:
      The unique ID of the field that is targeted by the tooltip.

    • label

      public final String label()

      The label of the tooltip item.

      Returns:
      The label of the tooltip item.

    • visibility

      public final Visibility visibility()

      The visibility of the tooltip item.

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

      Returns:
      The visibility of the tooltip item.
      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      The visibility of the tooltip item.

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

      Returns:
      The visibility of the tooltip item.
      See Also:

    • tooltipTarget

      public final TooltipTarget tooltipTarget()

      Determines the target of the field tooltip item in a combo chart visual.

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

      Returns:
      Determines the target of the field tooltip item in a combo chart visual.
      See Also:

    • tooltipTargetAsString

      public final String tooltipTargetAsString()

      Determines the target of the field tooltip item in a combo chart visual.

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

      Returns:
      Determines the target of the field tooltip item in a combo chart visual.
      See Also:

    • toBuilder

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

    • builder

      public static FieldTooltipItem.Builder builder()

    • serializableBuilderClass

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