Package software.amazon.awssdk.services.quicksight.model

Class KPIOptions

java.lang.Object

software.amazon.awssdk.services.quicksight.model.KPIOptions

All Implemented Interfaces:

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

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

The options that determine the presentation of a KPI visual.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KPIOptions.Builder

Method Summary

Modifier and Type	Method	Description
static KPIOptions.Builder	builder()
ComparisonConfiguration	comparison()	The comparison configuration of a KPI visual.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PrimaryValueDisplayType	primaryValueDisplayType()	The options that determine the primary value display type.
String	primaryValueDisplayTypeAsString()	The options that determine the primary value display type.
FontConfiguration	primaryValueFontConfiguration()	The options that determine the primary value font configuration.
ProgressBarOptions	progressBar()	The options that determine the presentation of the progress bar of a KPI visual.
List<SdkField<?>>	sdkFields()
SecondaryValueOptions	secondaryValue()	The options that determine the presentation of the secondary value of a KPI visual.
FontConfiguration	secondaryValueFontConfiguration()	The options that determine the secondary value font configuration.
static Class<? extends KPIOptions.Builder>	serializableBuilderClass()
KPISparklineOptions	sparkline()	The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
KPIOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TrendArrowOptions	trendArrows()	The options that determine the presentation of trend arrows in a KPI visual.
KPIVisualLayoutOptions	visualLayoutOptions()	The options that determine the layout a KPI visual.

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

progressBar

public final ProgressBarOptions progressBar()

The options that determine the presentation of the progress bar of a KPI visual.

Returns:

The options that determine the presentation of the progress bar of a KPI visual.

trendArrows

public final TrendArrowOptions trendArrows()

The options that determine the presentation of trend arrows in a KPI visual.

Returns:

The options that determine the presentation of trend arrows in a KPI visual.

secondaryValue

public final SecondaryValueOptions secondaryValue()

The options that determine the presentation of the secondary value of a KPI visual.

Returns:

The options that determine the presentation of the secondary value of a KPI visual.

comparison

public final ComparisonConfiguration comparison()

The comparison configuration of a KPI visual.

Returns:

The comparison configuration of a KPI visual.

primaryValueDisplayType

public final PrimaryValueDisplayType primaryValueDisplayType()

The options that determine the primary value display type.

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

Returns:

The options that determine the primary value display type.

See Also:

PrimaryValueDisplayType

primaryValueDisplayTypeAsString

public final String primaryValueDisplayTypeAsString()

The options that determine the primary value display type.

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

Returns:

The options that determine the primary value display type.

See Also:

PrimaryValueDisplayType

primaryValueFontConfiguration

public final FontConfiguration primaryValueFontConfiguration()

The options that determine the primary value font configuration.

Returns:

The options that determine the primary value font configuration.

secondaryValueFontConfiguration

public final FontConfiguration secondaryValueFontConfiguration()

The options that determine the secondary value font configuration.

Returns:

The options that determine the secondary value font configuration.

sparkline

public final KPISparklineOptions sparkline()

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

Returns:

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

visualLayoutOptions

public final KPIVisualLayoutOptions visualLayoutOptions()

The options that determine the layout a KPI visual.

Returns:

The options that determine the layout a KPI visual.

toBuilder

public KPIOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KPIOptions.Builder,KPIOptions>

builder

public static KPIOptions.Builder builder()

serializableBuilderClass

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