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

Interface InsightVisual.Builder

All Superinterfaces:

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

Enclosing class:

InsightVisual

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

Method Summary

Modifier and Type	Method	Description
InsightVisual.Builder	actions(Collection<VisualCustomAction> actions)	The list of custom actions that are configured for a visual.
InsightVisual.Builder	actions(Consumer<VisualCustomAction.Builder>... actions)	The list of custom actions that are configured for a visual.
InsightVisual.Builder	actions(VisualCustomAction... actions)	The list of custom actions that are configured for a visual.
InsightVisual.Builder	dataSetIdentifier(String dataSetIdentifier)	The dataset that is used in the insight visual.
default InsightVisual.Builder	insightConfiguration(Consumer<InsightConfiguration.Builder> insightConfiguration)	The configuration of an insight visual.
InsightVisual.Builder	insightConfiguration(InsightConfiguration insightConfiguration)	The configuration of an insight visual.
default InsightVisual.Builder	subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)	The subtitle that is displayed on the visual.
InsightVisual.Builder	subtitle(VisualSubtitleLabelOptions subtitle)	The subtitle that is displayed on the visual.
default InsightVisual.Builder	title(Consumer<VisualTitleLabelOptions.Builder> title)	The title that is displayed on the visual.
InsightVisual.Builder	title(VisualTitleLabelOptions title)	The title that is displayed on the visual.
InsightVisual.Builder	visualContentAltText(String visualContentAltText)	The alt text for the visual.
InsightVisual.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 Detail

visualId

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

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

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

insightConfiguration

InsightVisual.Builder insightConfiguration(InsightConfiguration insightConfiguration)

The configuration of an insight visual.

Parameters:

insightConfiguration - The configuration of an insight visual.

Returns:

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

insightConfiguration

default InsightVisual.Builder insightConfiguration(Consumer<InsightConfiguration.Builder> insightConfiguration)

The configuration of an insight visual.

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

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

Parameters:

insightConfiguration - a consumer that will call methods on InsightConfiguration.Builder

Returns:

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

See Also:

insightConfiguration(InsightConfiguration)

actions

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

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

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

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)

dataSetIdentifier

InsightVisual.Builder dataSetIdentifier(String dataSetIdentifier)

The dataset that is used in the insight visual.

Parameters:

dataSetIdentifier - The dataset that is used in the insight visual.

Returns:

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

visualContentAltText

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