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

Interface KPIOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<KPIOptions.Builder,KPIOptions>, SdkBuilder<KPIOptions.Builder,KPIOptions>, SdkPojo

Enclosing class:

KPIOptions

@Mutable
@NotThreadSafe
public static interface KPIOptions.Builder
extends SdkPojo, CopyableBuilder<KPIOptions.Builder,KPIOptions>

Method Summary

Modifier and Type	Method	Description
default KPIOptions.Builder	comparison(Consumer<ComparisonConfiguration.Builder> comparison)	The comparison configuration of a KPI visual.
KPIOptions.Builder	comparison(ComparisonConfiguration comparison)	The comparison configuration of a KPI visual.
KPIOptions.Builder	primaryValueDisplayType(String primaryValueDisplayType)	The options that determine the primary value display type.
KPIOptions.Builder	primaryValueDisplayType(PrimaryValueDisplayType primaryValueDisplayType)	The options that determine the primary value display type.
default KPIOptions.Builder	primaryValueFontConfiguration(Consumer<FontConfiguration.Builder> primaryValueFontConfiguration)	The options that determine the primary value font configuration.
KPIOptions.Builder	primaryValueFontConfiguration(FontConfiguration primaryValueFontConfiguration)	The options that determine the primary value font configuration.
default KPIOptions.Builder	progressBar(Consumer<ProgressBarOptions.Builder> progressBar)	The options that determine the presentation of the progress bar of a KPI visual.
KPIOptions.Builder	progressBar(ProgressBarOptions progressBar)	The options that determine the presentation of the progress bar of a KPI visual.
default KPIOptions.Builder	secondaryValue(Consumer<SecondaryValueOptions.Builder> secondaryValue)	The options that determine the presentation of the secondary value of a KPI visual.
KPIOptions.Builder	secondaryValue(SecondaryValueOptions secondaryValue)	The options that determine the presentation of the secondary value of a KPI visual.
default KPIOptions.Builder	secondaryValueFontConfiguration(Consumer<FontConfiguration.Builder> secondaryValueFontConfiguration)	The options that determine the secondary value font configuration.
KPIOptions.Builder	secondaryValueFontConfiguration(FontConfiguration secondaryValueFontConfiguration)	The options that determine the secondary value font configuration.
default KPIOptions.Builder	sparkline(Consumer<KPISparklineOptions.Builder> sparkline)	The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
KPIOptions.Builder	sparkline(KPISparklineOptions sparkline)	The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
default KPIOptions.Builder	trendArrows(Consumer<TrendArrowOptions.Builder> trendArrows)	The options that determine the presentation of trend arrows in a KPI visual.
KPIOptions.Builder	trendArrows(TrendArrowOptions trendArrows)	The options that determine the presentation of trend arrows in a KPI visual.
default KPIOptions.Builder	visualLayoutOptions(Consumer<KPIVisualLayoutOptions.Builder> visualLayoutOptions)	The options that determine the layout a KPI visual.
KPIOptions.Builder	visualLayoutOptions(KPIVisualLayoutOptions visualLayoutOptions)	The options that determine the layout a KPI visual.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

progressBar

KPIOptions.Builder progressBar(ProgressBarOptions progressBar)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

progressBar

default KPIOptions.Builder progressBar(Consumer<ProgressBarOptions.Builder> progressBar)

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

This is a convenience method that creates an instance of the ProgressBarOptions.Builder avoiding the need to create one manually via ProgressBarOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to progressBar(ProgressBarOptions).

Parameters:

progressBar - a consumer that will call methods on ProgressBarOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

progressBar(ProgressBarOptions)

trendArrows

KPIOptions.Builder trendArrows(TrendArrowOptions trendArrows)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

trendArrows

default KPIOptions.Builder trendArrows(Consumer<TrendArrowOptions.Builder> trendArrows)

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

This is a convenience method that creates an instance of the TrendArrowOptions.Builder avoiding the need to create one manually via TrendArrowOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trendArrows(TrendArrowOptions).

Parameters:

trendArrows - a consumer that will call methods on TrendArrowOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

trendArrows(TrendArrowOptions)

secondaryValue

KPIOptions.Builder secondaryValue(SecondaryValueOptions secondaryValue)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

secondaryValue

default KPIOptions.Builder secondaryValue(Consumer<SecondaryValueOptions.Builder> secondaryValue)

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

This is a convenience method that creates an instance of the SecondaryValueOptions.Builder avoiding the need to create one manually via SecondaryValueOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to secondaryValue(SecondaryValueOptions).

Parameters:

secondaryValue - a consumer that will call methods on SecondaryValueOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

secondaryValue(SecondaryValueOptions)

comparison

KPIOptions.Builder comparison(ComparisonConfiguration comparison)

The comparison configuration of a KPI visual.

Parameters:

comparison - The comparison configuration of a KPI visual.

Returns:

Returns a reference to this object so that method calls can be chained together.

comparison

default KPIOptions.Builder comparison(Consumer<ComparisonConfiguration.Builder> comparison)

The comparison configuration of a KPI visual.

This is a convenience method that creates an instance of the ComparisonConfiguration.Builder avoiding the need to create one manually via ComparisonConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to comparison(ComparisonConfiguration).

Parameters:

comparison - a consumer that will call methods on ComparisonConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

comparison(ComparisonConfiguration)

primaryValueDisplayType

KPIOptions.Builder primaryValueDisplayType(String primaryValueDisplayType)

The options that determine the primary value display type.

Parameters:

primaryValueDisplayType - The options that determine the primary value display type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PrimaryValueDisplayType, PrimaryValueDisplayType

primaryValueDisplayType

KPIOptions.Builder primaryValueDisplayType(PrimaryValueDisplayType primaryValueDisplayType)

The options that determine the primary value display type.

Parameters:

primaryValueDisplayType - The options that determine the primary value display type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PrimaryValueDisplayType, PrimaryValueDisplayType

primaryValueFontConfiguration

KPIOptions.Builder primaryValueFontConfiguration(FontConfiguration primaryValueFontConfiguration)

The options that determine the primary value font configuration.

Parameters:

primaryValueFontConfiguration - The options that determine the primary value font configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

primaryValueFontConfiguration

default KPIOptions.Builder primaryValueFontConfiguration(Consumer<FontConfiguration.Builder> primaryValueFontConfiguration)

The options that determine the primary value font configuration.

This is a convenience method that creates an instance of the FontConfiguration.Builder avoiding the need to create one manually via FontConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to primaryValueFontConfiguration(FontConfiguration).

Parameters:

primaryValueFontConfiguration - a consumer that will call methods on FontConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

primaryValueFontConfiguration(FontConfiguration)

secondaryValueFontConfiguration

KPIOptions.Builder secondaryValueFontConfiguration(FontConfiguration secondaryValueFontConfiguration)

The options that determine the secondary value font configuration.

Parameters:

secondaryValueFontConfiguration - The options that determine the secondary value font configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

secondaryValueFontConfiguration

default KPIOptions.Builder secondaryValueFontConfiguration(Consumer<FontConfiguration.Builder> secondaryValueFontConfiguration)

The options that determine the secondary value font configuration.

This is a convenience method that creates an instance of the FontConfiguration.Builder avoiding the need to create one manually via FontConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to secondaryValueFontConfiguration(FontConfiguration).

Parameters:

secondaryValueFontConfiguration - a consumer that will call methods on FontConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

secondaryValueFontConfiguration(FontConfiguration)

sparkline

KPIOptions.Builder sparkline(KPISparklineOptions sparkline)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sparkline

default KPIOptions.Builder sparkline(Consumer<KPISparklineOptions.Builder> sparkline)

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

This is a convenience method that creates an instance of the KPISparklineOptions.Builder avoiding the need to create one manually via KPISparklineOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sparkline(KPISparklineOptions).

Parameters:

sparkline - a consumer that will call methods on KPISparklineOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sparkline(KPISparklineOptions)

visualLayoutOptions

KPIOptions.Builder visualLayoutOptions(KPIVisualLayoutOptions visualLayoutOptions)

The options that determine the layout a KPI visual.

Parameters:

visualLayoutOptions - The options that determine the layout a KPI visual.

Returns:

Returns a reference to this object so that method calls can be chained together.

visualLayoutOptions

default KPIOptions.Builder visualLayoutOptions(Consumer<KPIVisualLayoutOptions.Builder> visualLayoutOptions)

The options that determine the layout a KPI visual.

This is a convenience method that creates an instance of the KPIVisualLayoutOptions.Builder avoiding the need to create one manually via KPIVisualLayoutOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to visualLayoutOptions(KPIVisualLayoutOptions).

Parameters:

visualLayoutOptions - a consumer that will call methods on KPIVisualLayoutOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

visualLayoutOptions(KPIVisualLayoutOptions)