Interface SankeyDiagramVisual.Builder

All Superinterfaces:

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

Enclosing class:

SankeyDiagramVisual

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

Method Summary

Modifier and Type	Method	Description
SankeyDiagramVisual.Builder	actions(Collection<VisualCustomAction> actions)	The list of custom actions that are configured for a visual.
SankeyDiagramVisual.Builder	actions(Consumer<VisualCustomAction.Builder>... actions)	The list of custom actions that are configured for a visual.
SankeyDiagramVisual.Builder	actions(VisualCustomAction... actions)	The list of custom actions that are configured for a visual.
default SankeyDiagramVisual.Builder	chartConfiguration(Consumer<SankeyDiagramChartConfiguration.Builder> chartConfiguration)	The configuration of a sankey diagram.
SankeyDiagramVisual.Builder	chartConfiguration(SankeyDiagramChartConfiguration chartConfiguration)	The configuration of a sankey diagram.
default SankeyDiagramVisual.Builder	subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)	The subtitle that is displayed on the visual.
SankeyDiagramVisual.Builder	subtitle(VisualSubtitleLabelOptions subtitle)	The subtitle that is displayed on the visual.
default SankeyDiagramVisual.Builder	title(Consumer<VisualTitleLabelOptions.Builder> title)	The title that is displayed on the visual.
SankeyDiagramVisual.Builder	title(VisualTitleLabelOptions title)	The title that is displayed on the visual.
SankeyDiagramVisual.Builder	visualContentAltText(String visualContentAltText)	The alt text for the visual.
SankeyDiagramVisual.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

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

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

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

SankeyDiagramVisual.Builder chartConfiguration(SankeyDiagramChartConfiguration chartConfiguration)

The configuration of a sankey diagram.

Parameters:

chartConfiguration - The configuration of a sankey diagram.

Returns:

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

chartConfiguration

default SankeyDiagramVisual.Builder chartConfiguration(Consumer<SankeyDiagramChartConfiguration.Builder> chartConfiguration)

The configuration of a sankey diagram.

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

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

Parameters:

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

Returns:

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

See Also:

• chartConfiguration(SankeyDiagramChartConfiguration)

actions

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

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

SankeyDiagramVisual.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>)

visualContentAltText

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