Interface KPIVisual.Builder

All Superinterfaces:

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

Enclosing class:

KPIVisual

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

Method Summary

Modifier and Type	Method	Description
KPIVisual.Builder	actions(Collection<VisualCustomAction> actions)	The list of custom actions that are configured for a visual.
KPIVisual.Builder	actions(Consumer<VisualCustomAction.Builder>... actions)	The list of custom actions that are configured for a visual.
KPIVisual.Builder	actions(VisualCustomAction... actions)	The list of custom actions that are configured for a visual.
default KPIVisual.Builder	chartConfiguration(Consumer<KPIConfiguration.Builder> chartConfiguration)	The configuration of a KPI visual.
KPIVisual.Builder	chartConfiguration(KPIConfiguration chartConfiguration)	The configuration of a KPI visual.
KPIVisual.Builder	columnHierarchies(Collection<ColumnHierarchy> columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
KPIVisual.Builder	columnHierarchies(Consumer<ColumnHierarchy.Builder>... columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
KPIVisual.Builder	columnHierarchies(ColumnHierarchy... columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
default KPIVisual.Builder	conditionalFormatting(Consumer<KPIConditionalFormatting.Builder> conditionalFormatting)	The conditional formatting of a KPI visual.
KPIVisual.Builder	conditionalFormatting(KPIConditionalFormatting conditionalFormatting)	The conditional formatting of a KPI visual.
default KPIVisual.Builder	subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)	The subtitle that is displayed on the visual.
KPIVisual.Builder	subtitle(VisualSubtitleLabelOptions subtitle)	The subtitle that is displayed on the visual.
default KPIVisual.Builder	title(Consumer<VisualTitleLabelOptions.Builder> title)	The title that is displayed on the visual.
KPIVisual.Builder	title(VisualTitleLabelOptions title)	The title that is displayed on the visual.
KPIVisual.Builder	visualContentAltText(String visualContentAltText)	The alt text for the visual.
KPIVisual.Builder	visualId(String visualId)	The unique identifier of a 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 Details

visualId

KPIVisual.Builder visualId(String visualId)

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Parameters:

visualId - The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Returns:

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

title

KPIVisual.Builder title(VisualTitleLabelOptions title)

The title that is displayed on the visual.

Parameters:

title - The title that is displayed on the visual.

Returns:

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

title

default KPIVisual.Builder title(Consumer<VisualTitleLabelOptions.Builder> title)

The title that is displayed on the visual.

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

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

Parameters:

title - a consumer that will call methods on VisualTitleLabelOptions.Builder

Returns:

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

See Also:

• title(VisualTitleLabelOptions)

subtitle

KPIVisual.Builder subtitle(VisualSubtitleLabelOptions subtitle)

The subtitle that is displayed on the visual.

Parameters:

subtitle - The subtitle that is displayed on the visual.

Returns:

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

subtitle

default KPIVisual.Builder subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)

The subtitle that is displayed on the visual.

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

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

Parameters:

subtitle - a consumer that will call methods on VisualSubtitleLabelOptions.Builder

Returns:

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

See Also:

• subtitle(VisualSubtitleLabelOptions)

chartConfiguration

KPIVisual.Builder chartConfiguration(KPIConfiguration chartConfiguration)

The configuration of a KPI visual.

Parameters:

chartConfiguration - The configuration of a KPI visual.

Returns:

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

chartConfiguration

default KPIVisual.Builder chartConfiguration(Consumer<KPIConfiguration.Builder> chartConfiguration)

The configuration of a KPI visual.

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

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

Parameters:

chartConfiguration - a consumer that will call methods on KPIConfiguration.Builder

Returns:

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

See Also:

• chartConfiguration(KPIConfiguration)

conditionalFormatting

KPIVisual.Builder conditionalFormatting(KPIConditionalFormatting conditionalFormatting)

The conditional formatting of a KPI visual.

Parameters:

conditionalFormatting - The conditional formatting of a KPI visual.

Returns:

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

conditionalFormatting

default KPIVisual.Builder conditionalFormatting(Consumer<KPIConditionalFormatting.Builder> conditionalFormatting)

The conditional formatting of a KPI visual.

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

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

Parameters:

conditionalFormatting - a consumer that will call methods on KPIConditionalFormatting.Builder

Returns:

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

See Also:

• conditionalFormatting(KPIConditionalFormatting)

actions

KPIVisual.Builder actions(Collection<VisualCustomAction> actions)

The list of custom actions that are configured for a visual.

Parameters:

actions - The list of custom actions that are configured for a visual.

Returns:

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

actions

KPIVisual.Builder actions(VisualCustomAction... actions)

The list of custom actions that are configured for a visual.

Parameters:

actions - The list of custom actions that are configured for a visual.

Returns:

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

actions

KPIVisual.Builder actions(Consumer<VisualCustomAction.Builder>... actions)

The list of custom actions that are configured for a visual.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actions(List<VisualCustomAction>).

Parameters:

actions - a consumer that will call methods on VisualCustomAction.Builder

Returns:

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

See Also:

• actions(java.util.Collection<VisualCustomAction>)

columnHierarchies

KPIVisual.Builder columnHierarchies(Collection<ColumnHierarchy> columnHierarchies)

The column hierarchy that is used during drill-downs and drill-ups.

Parameters:

columnHierarchies - The column hierarchy that is used during drill-downs and drill-ups.

Returns:

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

columnHierarchies

KPIVisual.Builder columnHierarchies(ColumnHierarchy... columnHierarchies)

The column hierarchy that is used during drill-downs and drill-ups.

Parameters:

columnHierarchies - The column hierarchy that is used during drill-downs and drill-ups.

Returns:

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

columnHierarchies

KPIVisual.Builder columnHierarchies(Consumer<ColumnHierarchy.Builder>... columnHierarchies)

The column hierarchy that is used during drill-downs and drill-ups.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columnHierarchies(List<ColumnHierarchy>).

Parameters:

columnHierarchies - a consumer that will call methods on ColumnHierarchy.Builder

Returns:

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

See Also:

• columnHierarchies(java.util.Collection<ColumnHierarchy>)

visualContentAltText

KPIVisual.Builder visualContentAltText(String visualContentAltText)

The alt text for the visual.

Parameters:

visualContentAltText - The alt text for the visual.

Returns:

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