Interface FilterListControl.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<FilterListControl.Builder,
,FilterListControl> SdkBuilder<FilterListControl.Builder,
,FilterListControl> SdkPojo
- Enclosing class:
FilterListControl
-
Method Summary
Modifier and TypeMethodDescriptiondefault FilterListControl.Builder
cascadingControlConfiguration
(Consumer<CascadingControlConfiguration.Builder> cascadingControlConfiguration) The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.cascadingControlConfiguration
(CascadingControlConfiguration cascadingControlConfiguration) The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.default FilterListControl.Builder
displayOptions
(Consumer<ListControlDisplayOptions.Builder> displayOptions) The display options of a control.displayOptions
(ListControlDisplayOptions displayOptions) The display options of a control.filterControlId
(String filterControlId) The ID of theFilterListControl
.default FilterListControl.Builder
selectableValues
(Consumer<FilterSelectableValues.Builder> selectableValues) A list of selectable values that are used in a control.selectableValues
(FilterSelectableValues selectableValues) A list of selectable values that are used in a control.sourceFilterId
(String sourceFilterId) The source filter ID of theFilterListControl
.The title of theFilterListControl
.The type of theFilterListControl
.type
(SheetControlListType type) The type of theFilterListControl
.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
-
filterControlId
The ID of the
FilterListControl
.- Parameters:
filterControlId
- The ID of theFilterListControl
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
title
The title of the
FilterListControl
.- Parameters:
title
- The title of theFilterListControl
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceFilterId
The source filter ID of the
FilterListControl
.- Parameters:
sourceFilterId
- The source filter ID of theFilterListControl
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayOptions
The display options of a control.
- Parameters:
displayOptions
- The display options of a control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayOptions
default FilterListControl.Builder displayOptions(Consumer<ListControlDisplayOptions.Builder> displayOptions) The display options of a control.
This is a convenience method that creates an instance of theListControlDisplayOptions.Builder
avoiding the need to create one manually viaListControlDisplayOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todisplayOptions(ListControlDisplayOptions)
.- Parameters:
displayOptions
- a consumer that will call methods onListControlDisplayOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The type of the
FilterListControl
. Choose one of the following options:-
MULTI_SELECT
: The user can select multiple entries from the list. -
SINGLE_SELECT
: The user can select a single entry from the list.
- Parameters:
type
- The type of theFilterListControl
. Choose one of the following options:-
MULTI_SELECT
: The user can select multiple entries from the list. -
SINGLE_SELECT
: The user can select a single entry from the list.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
type
The type of the
FilterListControl
. Choose one of the following options:-
MULTI_SELECT
: The user can select multiple entries from the list. -
SINGLE_SELECT
: The user can select a single entry from the list.
- Parameters:
type
- The type of theFilterListControl
. Choose one of the following options:-
MULTI_SELECT
: The user can select multiple entries from the list. -
SINGLE_SELECT
: The user can select a single entry from the list.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
selectableValues
A list of selectable values that are used in a control.
- Parameters:
selectableValues
- A list of selectable values that are used in a control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
selectableValues
default FilterListControl.Builder selectableValues(Consumer<FilterSelectableValues.Builder> selectableValues) A list of selectable values that are used in a control.
This is a convenience method that creates an instance of theFilterSelectableValues.Builder
avoiding the need to create one manually viaFilterSelectableValues.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toselectableValues(FilterSelectableValues)
.- Parameters:
selectableValues
- a consumer that will call methods onFilterSelectableValues.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cascadingControlConfiguration
FilterListControl.Builder cascadingControlConfiguration(CascadingControlConfiguration cascadingControlConfiguration) The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
- Parameters:
cascadingControlConfiguration
- The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cascadingControlConfiguration
default FilterListControl.Builder cascadingControlConfiguration(Consumer<CascadingControlConfiguration.Builder> cascadingControlConfiguration) The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
This is a convenience method that creates an instance of theCascadingControlConfiguration.Builder
avoiding the need to create one manually viaCascadingControlConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocascadingControlConfiguration(CascadingControlConfiguration)
.- Parameters:
cascadingControlConfiguration
- a consumer that will call methods onCascadingControlConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-