software.amazon.awssdk.services.quicksight.model

Class FieldBasedTooltip

java.lang.Object

software.amazon.awssdk.services.quicksight.model.FieldBasedTooltip

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FieldBasedTooltip.Builder,FieldBasedTooltip>

@Generated(value="software.amazon.awssdk:codegen")
public final class FieldBasedTooltip
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FieldBasedTooltip.Builder,FieldBasedTooltip>

The setup for the detailed tooltip.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FieldBasedTooltip.Builder

Method Summary

Modifier and Type	Method and Description
Visibility	aggregationVisibility() The visibility of Show aggregations.
String	aggregationVisibilityAsString() The visibility of Show aggregations.
static FieldBasedTooltip.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTooltipFields() For responses, this returns true if the service returned a value for the TooltipFields property.
List<SdkField<?>>	sdkFields()
static Class<? extends FieldBasedTooltip.Builder>	serializableBuilderClass()
FieldBasedTooltip.Builder	toBuilder()
List<TooltipItem>	tooltipFields() The fields configuration in the tooltip.
TooltipTitleType	tooltipTitleType() The type for the >tooltip title.
String	tooltipTitleTypeAsString() The type for the >tooltip title.
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

aggregationVisibility

public final Visibility aggregationVisibility()

The visibility of Show aggregations.

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

Returns:

The visibility of Show aggregations.

See Also:

Visibility

aggregationVisibilityAsString

public final String aggregationVisibilityAsString()

The visibility of Show aggregations.

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

Returns:

The visibility of Show aggregations.

See Also:

Visibility

tooltipTitleType

public final TooltipTitleType tooltipTitleType()

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

• NONE: Doesn't use the primary value as the title.

• PRIMARY_VALUE: Uses primary value as the title.

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

Returns:

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

• NONE: Doesn't use the primary value as the title.

• PRIMARY_VALUE: Uses primary value as the title.

See Also:

TooltipTitleType

tooltipTitleTypeAsString

public final String tooltipTitleTypeAsString()

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

• NONE: Doesn't use the primary value as the title.

• PRIMARY_VALUE: Uses primary value as the title.

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

Returns:

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

• NONE: Doesn't use the primary value as the title.

• PRIMARY_VALUE: Uses primary value as the title.

See Also:

TooltipTitleType

hasTooltipFields

public final boolean hasTooltipFields()

For responses, this returns true if the service returned a value for the TooltipFields 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.

tooltipFields

public final List<TooltipItem> tooltipFields()

The fields configuration in the tooltip.

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 hasTooltipFields() method.

Returns:

The fields configuration in the tooltip.

toBuilder

public FieldBasedTooltip.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FieldBasedTooltip.Builder,FieldBasedTooltip>

builder

public static FieldBasedTooltip.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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