Interface SheetDefinition.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SheetDefinition.Builder,
,SheetDefinition> SdkBuilder<SheetDefinition.Builder,
,SheetDefinition> SdkPojo
- Enclosing class:
SheetDefinition
-
Method Summary
Modifier and TypeMethodDescriptioncontentType
(String contentType) The layout content type of the sheet.contentType
(SheetContentType contentType) The layout content type of the sheet.description
(String description) A description of the sheet.filterControls
(Collection<FilterControl> filterControls) The list of filter controls that are on a sheet.filterControls
(Consumer<FilterControl.Builder>... filterControls) The list of filter controls that are on a sheet.filterControls
(FilterControl... filterControls) The list of filter controls that are on a sheet.layouts
(Collection<Layout> layouts) Layouts define how the components of a sheet are arranged.layouts
(Consumer<Layout.Builder>... layouts) Layouts define how the components of a sheet are arranged.Layouts define how the components of a sheet are arranged.The name of the sheet.parameterControls
(Collection<ParameterControl> parameterControls) The list of parameter controls that are on a sheet.parameterControls
(Consumer<ParameterControl.Builder>... parameterControls) The list of parameter controls that are on a sheet.parameterControls
(ParameterControl... parameterControls) The list of parameter controls that are on a sheet.sheetControlLayouts
(Collection<SheetControlLayout> sheetControlLayouts) The control layouts of the sheet.sheetControlLayouts
(Consumer<SheetControlLayout.Builder>... sheetControlLayouts) The control layouts of the sheet.sheetControlLayouts
(SheetControlLayout... sheetControlLayouts) The control layouts of the sheet.The unique identifier of a sheet.textBoxes
(Collection<SheetTextBox> textBoxes) The text boxes that are on a sheet.textBoxes
(Consumer<SheetTextBox.Builder>... textBoxes) The text boxes that are on a sheet.textBoxes
(SheetTextBox... textBoxes) The text boxes that are on a sheet.The title of the sheet.visuals
(Collection<Visual> visuals) A list of the visuals that are on a sheet.visuals
(Consumer<Visual.Builder>... visuals) A list of the visuals that are on a sheet.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, sdkFields
-
Method Details
-
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
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
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
The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
- Parameters:
name
- The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameterControls
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight 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 QuickSight in the Amazon QuickSight User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameterControls
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight 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 QuickSight in the Amazon QuickSight User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameterControls
The list of parameter controls that are on a sheet.
For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
This is a convenience method that creates an instance of theParameterControl.Builder
avoiding the need to create one manually viaParameterControl.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparameterControls(List<ParameterControl>)
.- Parameters:
parameterControls
- a consumer that will call methods onParameterControl.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
filterControls
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight 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 QuickSight User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterControls
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight 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 QuickSight User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterControls
The list of filter controls that are on a sheet.
For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.
This is a convenience method that creates an instance of theFilterControl.Builder
avoiding the need to create one manually viaFilterControl.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilterControls(List<FilterControl>)
.- Parameters:
filterControls
- a consumer that will call methods onFilterControl.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theVisual.Builder
avoiding the need to create one manually viaVisual.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovisuals(List<Visual>)
.- Parameters:
visuals
- a consumer that will call methods onVisual.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
The text boxes that are on a sheet.
This is a convenience method that creates an instance of theSheetTextBox.Builder
avoiding the need to create one manually viaSheetTextBox.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totextBoxes(List<SheetTextBox>)
.- Parameters:
textBoxes
- a consumer that will call methods onSheetTextBox.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
layouts
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
- Parameters:
layouts
- Layouts define how the components of a sheet are arranged.For more information, see Types of layout in the Amazon QuickSight User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
layouts
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
- Parameters:
layouts
- Layouts define how the components of a sheet are arranged.For more information, see Types of layout in the Amazon QuickSight User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
layouts
Layouts define how the components of a sheet are arranged.
For more information, see Types of layout in the Amazon QuickSight User Guide.
This is a convenience method that creates an instance of theLayout.Builder
avoiding the need to create one manually viaLayout.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolayouts(List<Layout>)
.- Parameters:
layouts
- a consumer that will call methods onLayout.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theSheetControlLayout.Builder
avoiding the need to create one manually viaSheetControlLayout.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosheetControlLayouts(List<SheetControlLayout>)
.- Parameters:
sheetControlLayouts
- a consumer that will call methods onSheetControlLayout.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
-
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:
-
-