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

Interface CustomContentVisual.Builder

All Superinterfaces:

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

Enclosing class:

CustomContentVisual

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

Method Summary

Modifier and Type	Method	Description
CustomContentVisual.Builder	actions(Collection<VisualCustomAction> actions)	The list of custom actions that are configured for a visual.
CustomContentVisual.Builder	actions(Consumer<VisualCustomAction.Builder>... actions)	The list of custom actions that are configured for a visual.
CustomContentVisual.Builder	actions(VisualCustomAction... actions)	The list of custom actions that are configured for a visual.
default CustomContentVisual.Builder	chartConfiguration(Consumer<CustomContentConfiguration.Builder> chartConfiguration)	The configuration of a CustomContentVisual.
CustomContentVisual.Builder	chartConfiguration(CustomContentConfiguration chartConfiguration)	The configuration of a CustomContentVisual.
CustomContentVisual.Builder	dataSetIdentifier(String dataSetIdentifier)	The dataset that is used to create the custom content visual.
default CustomContentVisual.Builder	subtitle(Consumer<VisualSubtitleLabelOptions.Builder> subtitle)	The subtitle that is displayed on the visual.
CustomContentVisual.Builder	subtitle(VisualSubtitleLabelOptions subtitle)	The subtitle that is displayed on the visual.
default CustomContentVisual.Builder	title(Consumer<VisualTitleLabelOptions.Builder> title)	The title that is displayed on the visual.
CustomContentVisual.Builder	title(VisualTitleLabelOptions title)	The title that is displayed on the visual.
CustomContentVisual.Builder	visualContentAltText(String visualContentAltText)	The alt text for the visual.
CustomContentVisual.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

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

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

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

CustomContentVisual.Builder chartConfiguration(CustomContentConfiguration chartConfiguration)

The configuration of a CustomContentVisual.

Parameters:

chartConfiguration - The configuration of a CustomContentVisual.

Returns:

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

chartConfiguration

default CustomContentVisual.Builder chartConfiguration(Consumer<CustomContentConfiguration.Builder> chartConfiguration)

The configuration of a CustomContentVisual.

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

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

Parameters:

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

Returns:

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

See Also:

chartConfiguration(CustomContentConfiguration)

actions

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

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

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

CustomContentVisual.Builder dataSetIdentifier(String dataSetIdentifier)

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

Parameters:

dataSetIdentifier - The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

Returns:

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

visualContentAltText

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