Interface WaterfallVisual.Builder

All Superinterfaces:

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

Enclosing class:

WaterfallVisual

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

Method Summary

Modifier and Type	Method	Description
WaterfallVisual.Builder	actions(Collection<VisualCustomAction> actions)	The list of custom actions that are configured for a visual.
WaterfallVisual.Builder	actions(Consumer<VisualCustomAction.Builder>... actions)	The list of custom actions that are configured for a visual.
WaterfallVisual.Builder	actions(VisualCustomAction... actions)	The list of custom actions that are configured for a visual.
default WaterfallVisual.Builder	chartConfiguration(Consumer<WaterfallChartConfiguration.Builder> chartConfiguration)	The configuration for a waterfall visual.
WaterfallVisual.Builder	chartConfiguration(WaterfallChartConfiguration chartConfiguration)	The configuration for a waterfall visual.
WaterfallVisual.Builder	columnHierarchies(Collection<ColumnHierarchy> columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
WaterfallVisual.Builder	columnHierarchies(Consumer<ColumnHierarchy.Builder>... columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
WaterfallVisual.Builder	columnHierarchies(ColumnHierarchy... columnHierarchies)	The column hierarchy that is used during drill-downs and drill-ups.
default WaterfallVisual.Builder	subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)	The subtitle that is displayed on the visual.
WaterfallVisual.Builder	subtitle(VisualSubtitleLabelOptions subtitle)	The subtitle that is displayed on the visual.
default WaterfallVisual.Builder	title(Consumer<VisualTitleLabelOptions.Builder> title)	The title that is displayed on the visual.
WaterfallVisual.Builder	title(VisualTitleLabelOptions title)	The title that is displayed on the visual.
WaterfallVisual.Builder	visualContentAltText(String visualContentAltText)	The alt text for the visual.
WaterfallVisual.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

WaterfallVisual.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

WaterfallVisual.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 WaterfallVisual.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

WaterfallVisual.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 WaterfallVisual.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

WaterfallVisual.Builder chartConfiguration(WaterfallChartConfiguration chartConfiguration)

The configuration for a waterfall visual.

Parameters:

chartConfiguration - The configuration for a waterfall visual.

Returns:

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

chartConfiguration

default WaterfallVisual.Builder chartConfiguration(Consumer<WaterfallChartConfiguration.Builder> chartConfiguration)

The configuration for a waterfall visual.

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

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

Parameters:

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

Returns:

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

See Also:

• chartConfiguration(WaterfallChartConfiguration)

actions

WaterfallVisual.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

WaterfallVisual.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

WaterfallVisual.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

WaterfallVisual.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

WaterfallVisual.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

WaterfallVisual.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

WaterfallVisual.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.