Interface FilterListControl.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<FilterListControl.Builder,FilterListControl>,SdkBuilder<FilterListControl.Builder,FilterListControl>,SdkPojo
- Enclosing class:
- FilterListControl
@Mutable @NotThreadSafe public static interface FilterListControl.Builder extends SdkPojo, CopyableBuilder<FilterListControl.Builder,FilterListControl>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default FilterListControl.BuildercascadingControlConfiguration(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.FilterListControl.BuildercascadingControlConfiguration(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.BuilderdisplayOptions(Consumer<ListControlDisplayOptions.Builder> displayOptions)The display options of a control.FilterListControl.BuilderdisplayOptions(ListControlDisplayOptions displayOptions)The display options of a control.FilterListControl.BuilderfilterControlId(String filterControlId)The ID of theFilterListControl.default FilterListControl.BuilderselectableValues(Consumer<FilterSelectableValues.Builder> selectableValues)A list of selectable values that are used in a control.FilterListControl.BuilderselectableValues(FilterSelectableValues selectableValues)A list of selectable values that are used in a control.FilterListControl.BuildersourceFilterId(String sourceFilterId)The source filter ID of theFilterListControl.FilterListControl.Buildertitle(String title)The title of theFilterListControl.FilterListControl.Buildertype(String type)The type of theFilterListControl.FilterListControl.Buildertype(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, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
filterControlId
FilterListControl.Builder filterControlId(String 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
FilterListControl.Builder title(String 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
FilterListControl.Builder sourceFilterId(String 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
FilterListControl.Builder displayOptions(ListControlDisplayOptions 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.Builderavoiding the need to create one manually viaListControlDisplayOptions.builder().When the
Consumercompletes,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:
displayOptions(ListControlDisplayOptions)
-
type
FilterListControl.Builder type(String 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:
SheetControlListType,SheetControlListType
-
-
type
FilterListControl.Builder type(SheetControlListType 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:
SheetControlListType,SheetControlListType
-
-
selectableValues
FilterListControl.Builder selectableValues(FilterSelectableValues 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.Builderavoiding the need to create one manually viaFilterSelectableValues.builder().When the
Consumercompletes,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:
selectableValues(FilterSelectableValues)
-
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.Builderavoiding the need to create one manually viaCascadingControlConfiguration.builder().When the
Consumercompletes,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:
cascadingControlConfiguration(CascadingControlConfiguration)
-
-