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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
TooltipOptions.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TooltipOptions.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
FieldBasedTooltip
fieldBasedTooltip()
The setup for the detailed tooltip.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
SelectedTooltipType
selectedTooltipType()
The selected type for the tooltip.String
selectedTooltipTypeAsString()
The selected type for the tooltip.static Class<? extends TooltipOptions.Builder>
serializableBuilderClass()
TooltipOptions.Builder
toBuilder()
Visibility
tooltipVisibility()
Determines whether or not the tooltip is visible.String
tooltipVisibilityAsString()
Determines whether or not the tooltip is visible.String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtooltipVisibilityAsString()
.- Returns:
- Determines whether or not the tooltip is visible.
- See Also:
Visibility
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtooltipVisibilityAsString()
.- Returns:
- Determines whether or not the tooltip is visible.
- See Also:
Visibility
-
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 returnSelectedTooltipType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromselectedTooltipTypeAsString()
.- Returns:
- The selected type for the tooltip. Choose one of the following options:
-
BASIC
: A basic tooltip. -
DETAILED
: A detailed tooltip.
-
- See Also:
SelectedTooltipType
-
-
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 returnSelectedTooltipType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromselectedTooltipTypeAsString()
.- Returns:
- The selected type for the tooltip. Choose one of the following options:
-
BASIC
: A basic tooltip. -
DETAILED
: A detailed tooltip.
-
- See Also:
SelectedTooltipType
-
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<TooltipOptions.Builder,TooltipOptions>
-
builder
public static TooltipOptions.Builder builder()
-
serializableBuilderClass
public static Class<? extends TooltipOptions.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-