Interface TableVisual.Builder

All Superinterfaces:

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

Enclosing class:

TableVisual

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

Method Summary

Modifier and Type	Method	Description
TableVisual.Builder	actions(Collection<VisualCustomAction> actions)	The list of custom actions that are configured for a visual.
TableVisual.Builder	actions(Consumer<VisualCustomAction.Builder>... actions)	The list of custom actions that are configured for a visual.
TableVisual.Builder	actions(VisualCustomAction... actions)	The list of custom actions that are configured for a visual.
default TableVisual.Builder	chartConfiguration(Consumer<TableConfiguration.Builder> chartConfiguration)	The configuration settings of the visual.
TableVisual.Builder	chartConfiguration(TableConfiguration chartConfiguration)	The configuration settings of the visual.
default TableVisual.Builder	conditionalFormatting(Consumer<TableConditionalFormatting.Builder> conditionalFormatting)	The conditional formatting for a PivotTableVisual.
TableVisual.Builder	conditionalFormatting(TableConditionalFormatting conditionalFormatting)	The conditional formatting for a PivotTableVisual.
default TableVisual.Builder	subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)	The subtitle that is displayed on the visual.
TableVisual.Builder	subtitle(VisualSubtitleLabelOptions subtitle)	The subtitle that is displayed on the visual.
default TableVisual.Builder	title(Consumer<VisualTitleLabelOptions.Builder> title)	The title that is displayed on the visual.
TableVisual.Builder	title(VisualTitleLabelOptions title)	The title that is displayed on the visual.
TableVisual.Builder	visualContentAltText(String visualContentAltText)	The alt text for the visual.
TableVisual.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

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

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

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

TableVisual.Builder chartConfiguration(TableConfiguration chartConfiguration)

The configuration settings of the visual.

Parameters:

chartConfiguration - The configuration settings of the visual.

Returns:

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

chartConfiguration

default TableVisual.Builder chartConfiguration(Consumer<TableConfiguration.Builder> chartConfiguration)

The configuration settings of the visual.

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

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

Parameters:

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

Returns:

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

See Also:

• chartConfiguration(TableConfiguration)

conditionalFormatting

TableVisual.Builder conditionalFormatting(TableConditionalFormatting conditionalFormatting)

The conditional formatting for a PivotTableVisual.

Parameters:

conditionalFormatting - The conditional formatting for a PivotTableVisual.

Returns:

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

conditionalFormatting

default TableVisual.Builder conditionalFormatting(Consumer<TableConditionalFormatting.Builder> conditionalFormatting)

The conditional formatting for a PivotTableVisual.

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

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

Parameters:

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

Returns:

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

See Also:

• conditionalFormatting(TableConditionalFormatting)

actions

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

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

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

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