Interface SheetDefinition.Builder

All Superinterfaces:

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

Enclosing class:

SheetDefinition

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

Method Summary

Modifier and Type	Method	Description
SheetDefinition.Builder	contentType(String contentType)	The layout content type of the sheet.
SheetDefinition.Builder	contentType(SheetContentType contentType)	The layout content type of the sheet.
default SheetDefinition.Builder	customActionDefaults(Consumer<VisualCustomActionDefaults.Builder> customActionDefaults)	A list of visual custom actions for the sheet.
SheetDefinition.Builder	customActionDefaults(VisualCustomActionDefaults customActionDefaults)	A list of visual custom actions for the sheet.
SheetDefinition.Builder	description(String description)	A description of the sheet.
SheetDefinition.Builder	filterControls(Collection<FilterControl> filterControls)	The list of filter controls that are on a sheet.
SheetDefinition.Builder	filterControls(Consumer<FilterControl.Builder>... filterControls)	The list of filter controls that are on a sheet.
SheetDefinition.Builder	filterControls(FilterControl... filterControls)	The list of filter controls that are on a sheet.
SheetDefinition.Builder	images(Collection<SheetImage> images)	A list of images on a sheet.
SheetDefinition.Builder	images(Consumer<SheetImage.Builder>... images)	A list of images on a sheet.
SheetDefinition.Builder	images(SheetImage... images)	A list of images on a sheet.
SheetDefinition.Builder	layouts(Collection<Layout> layouts)	Layouts define how the components of a sheet are arranged.
SheetDefinition.Builder	layouts(Consumer<Layout.Builder>... layouts)	Layouts define how the components of a sheet are arranged.
SheetDefinition.Builder	layouts(Layout... layouts)	Layouts define how the components of a sheet are arranged.
SheetDefinition.Builder	name(String name)	The name of the sheet.
SheetDefinition.Builder	parameterControls(Collection<ParameterControl> parameterControls)	The list of parameter controls that are on a sheet.
SheetDefinition.Builder	parameterControls(Consumer<ParameterControl.Builder>... parameterControls)	The list of parameter controls that are on a sheet.
SheetDefinition.Builder	parameterControls(ParameterControl... parameterControls)	The list of parameter controls that are on a sheet.
SheetDefinition.Builder	sheetControlLayouts(Collection<SheetControlLayout> sheetControlLayouts)	The control layouts of the sheet.
SheetDefinition.Builder	sheetControlLayouts(Consumer<SheetControlLayout.Builder>... sheetControlLayouts)	The control layouts of the sheet.
SheetDefinition.Builder	sheetControlLayouts(SheetControlLayout... sheetControlLayouts)	The control layouts of the sheet.
SheetDefinition.Builder	sheetId(String sheetId)	The unique identifier of a sheet.
SheetDefinition.Builder	textBoxes(Collection<SheetTextBox> textBoxes)	The text boxes that are on a sheet.
SheetDefinition.Builder	textBoxes(Consumer<SheetTextBox.Builder>... textBoxes)	The text boxes that are on a sheet.
SheetDefinition.Builder	textBoxes(SheetTextBox... textBoxes)	The text boxes that are on a sheet.
SheetDefinition.Builder	title(String title)	The title of the sheet.
SheetDefinition.Builder	visuals(Collection<Visual> visuals)	A list of the visuals that are on a sheet.
SheetDefinition.Builder	visuals(Consumer<Visual.Builder>... visuals)	A list of the visuals that are on a sheet.
SheetDefinition.Builder	visuals(Visual... visuals)	A list of the visuals that are on a sheet.

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

sheetId

SheetDefinition.Builder sheetId(String sheetId)

The unique identifier of a sheet.

Parameters:

sheetId - The unique identifier of a sheet.

Returns:

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

title

SheetDefinition.Builder title(String title)

The title of the sheet.

Parameters:

title - The title of the sheet.

Returns:

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

description

SheetDefinition.Builder description(String description)

A description of the sheet.

Parameters:

description - A description of the sheet.

Returns:

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

name

SheetDefinition.Builder name(String name)

The name of the sheet. This name is displayed on the sheet's tab in the QuickSight console.

Parameters:

name - The name of the sheet. This name is displayed on the sheet's tab in the QuickSight console.

Returns:

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

parameterControls

SheetDefinition.Builder parameterControls(Collection<ParameterControl> parameterControls)

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Parameters:

parameterControls - The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Returns:

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

parameterControls

SheetDefinition.Builder parameterControls(ParameterControl... parameterControls)

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Parameters:

parameterControls - The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide.

Returns:

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

parameterControls

SheetDefinition.Builder parameterControls(Consumer<ParameterControl.Builder>... parameterControls)

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterControls(List<ParameterControl>).

Parameters:

parameterControls - a consumer that will call methods on ParameterControl.Builder

Returns:

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

See Also:

• parameterControls(java.util.Collection<ParameterControl>)

filterControls

SheetDefinition.Builder filterControls(Collection<FilterControl> filterControls)

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide.

Parameters:

filterControls - The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide.

Returns:

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

filterControls

SheetDefinition.Builder filterControls(FilterControl... filterControls)

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide.

Parameters:

filterControls - The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide.

Returns:

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

filterControls

SheetDefinition.Builder filterControls(Consumer<FilterControl.Builder>... filterControls)

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterControls(List<FilterControl>).

Parameters:

filterControls - a consumer that will call methods on FilterControl.Builder

Returns:

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

See Also:

• filterControls(java.util.Collection<FilterControl>)

visuals

SheetDefinition.Builder visuals(Collection<Visual> visuals)

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

Parameters:

visuals - A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

Returns:

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

visuals

SheetDefinition.Builder visuals(Visual... visuals)

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

Parameters:

visuals - A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

Returns:

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

visuals

SheetDefinition.Builder visuals(Consumer<Visual.Builder>... visuals)

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to visuals(List<Visual>).

Parameters:

visuals - a consumer that will call methods on Visual.Builder

Returns:

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

See Also:

• visuals(java.util.Collection<Visual>)

textBoxes

SheetDefinition.Builder textBoxes(Collection<SheetTextBox> textBoxes)

The text boxes that are on a sheet.

Parameters:

textBoxes - The text boxes that are on a sheet.

Returns:

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

textBoxes

SheetDefinition.Builder textBoxes(SheetTextBox... textBoxes)

The text boxes that are on a sheet.

Parameters:

textBoxes - The text boxes that are on a sheet.

Returns:

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

textBoxes

SheetDefinition.Builder textBoxes(Consumer<SheetTextBox.Builder>... textBoxes)

The text boxes that are on a sheet.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to textBoxes(List<SheetTextBox>).

Parameters:

textBoxes - a consumer that will call methods on SheetTextBox.Builder

Returns:

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

See Also:

• textBoxes(java.util.Collection<SheetTextBox>)

images

SheetDefinition.Builder images(Collection<SheetImage> images)

A list of images on a sheet.

Parameters:

images - A list of images on a sheet.

Returns:

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

images

SheetDefinition.Builder images(SheetImage... images)

A list of images on a sheet.

Parameters:

images - A list of images on a sheet.

Returns:

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

images

SheetDefinition.Builder images(Consumer<SheetImage.Builder>... images)

A list of images on a sheet.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to images(List<SheetImage>).

Parameters:

images - a consumer that will call methods on SheetImage.Builder

Returns:

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

See Also:

• images(java.util.Collection<SheetImage>)

layouts

SheetDefinition.Builder layouts(Collection<Layout> layouts)

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

Parameters:

layouts - Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

Returns:

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

layouts

SheetDefinition.Builder layouts(Layout... layouts)

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

Parameters:

layouts - Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

Returns:

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

layouts

SheetDefinition.Builder layouts(Consumer<Layout.Builder>... layouts)

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to layouts(List<Layout>).

Parameters:

layouts - a consumer that will call methods on Layout.Builder

Returns:

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

See Also:

• layouts(java.util.Collection<Layout>)

sheetControlLayouts

SheetDefinition.Builder sheetControlLayouts(Collection<SheetControlLayout> sheetControlLayouts)

The control layouts of the sheet.

Parameters:

sheetControlLayouts - The control layouts of the sheet.

Returns:

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

sheetControlLayouts

SheetDefinition.Builder sheetControlLayouts(SheetControlLayout... sheetControlLayouts)

The control layouts of the sheet.

Parameters:

sheetControlLayouts - The control layouts of the sheet.

Returns:

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

sheetControlLayouts

SheetDefinition.Builder sheetControlLayouts(Consumer<SheetControlLayout.Builder>... sheetControlLayouts)

The control layouts of the sheet.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sheetControlLayouts(List<SheetControlLayout>).

Parameters:

sheetControlLayouts - a consumer that will call methods on SheetControlLayout.Builder

Returns:

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

See Also:

• sheetControlLayouts(java.util.Collection<SheetControlLayout>)

contentType

SheetDefinition.Builder contentType(String contentType)

The layout content type of the sheet. Choose one of the following options:

• PAGINATED: Creates a sheet for a paginated report.

• INTERACTIVE: Creates a sheet for an interactive dashboard.

Parameters:

contentType - The layout content type of the sheet. Choose one of the following options:

• PAGINATED: Creates a sheet for a paginated report.

• INTERACTIVE: Creates a sheet for an interactive dashboard.

Returns:

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

See Also:

• SheetContentType
• SheetContentType

contentType

SheetDefinition.Builder contentType(SheetContentType contentType)

The layout content type of the sheet. Choose one of the following options:

• PAGINATED: Creates a sheet for a paginated report.

• INTERACTIVE: Creates a sheet for an interactive dashboard.

Parameters:

contentType - The layout content type of the sheet. Choose one of the following options:

• PAGINATED: Creates a sheet for a paginated report.

• INTERACTIVE: Creates a sheet for an interactive dashboard.

Returns:

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

See Also:

• SheetContentType
• SheetContentType

customActionDefaults

SheetDefinition.Builder customActionDefaults(VisualCustomActionDefaults customActionDefaults)

A list of visual custom actions for the sheet.

Parameters:

customActionDefaults - A list of visual custom actions for the sheet.

Returns:

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

customActionDefaults

default SheetDefinition.Builder customActionDefaults(Consumer<VisualCustomActionDefaults.Builder> customActionDefaults)

A list of visual custom actions for the sheet.

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

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

Parameters:

customActionDefaults - a consumer that will call methods on VisualCustomActionDefaults.Builder

Returns:

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

See Also:

• customActionDefaults(VisualCustomActionDefaults)