Interface NumericRangeFilter.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<NumericRangeFilter.Builder,
,NumericRangeFilter> SdkBuilder<NumericRangeFilter.Builder,
,NumericRangeFilter> SdkPojo
- Enclosing class:
NumericRangeFilter
-
Method Summary
Modifier and TypeMethodDescriptiondefault NumericRangeFilter.Builder
aggregationFunction
(Consumer<AggregationFunction.Builder> aggregationFunction) The aggregation function of the filter.aggregationFunction
(AggregationFunction aggregationFunction) The aggregation function of the filter.default NumericRangeFilter.Builder
column
(Consumer<ColumnIdentifier.Builder> column) The column that the filter is applied to.column
(ColumnIdentifier column) The column that the filter is applied to.default NumericRangeFilter.Builder
defaultFilterControlConfiguration
(Consumer<DefaultFilterControlConfiguration.Builder> defaultFilterControlConfiguration) The default configurations for the associated controls.defaultFilterControlConfiguration
(DefaultFilterControlConfiguration defaultFilterControlConfiguration) The default configurations for the associated controls.An identifier that uniquely identifies a filter within a dashboard, analysis, or template.includeMaximum
(Boolean includeMaximum) Determines whether the maximum value in the filter value range should be included in the filtered results.includeMinimum
(Boolean includeMinimum) Determines whether the minimum value in the filter value range should be included in the filtered results.nullOption
(String nullOption) This option determines how null values should be treated when filtering data.nullOption
(FilterNullOption nullOption) This option determines how null values should be treated when filtering data.default NumericRangeFilter.Builder
rangeMaximum
(Consumer<NumericRangeFilterValue.Builder> rangeMaximum) The maximum value for the filter value range.rangeMaximum
(NumericRangeFilterValue rangeMaximum) The maximum value for the filter value range.default NumericRangeFilter.Builder
rangeMinimum
(Consumer<NumericRangeFilterValue.Builder> rangeMinimum) The minimum value for the filter value range.rangeMinimum
(NumericRangeFilterValue rangeMinimum) The minimum value for the filter value range.selectAllOptions
(String selectAllOptions) Select all of the values.selectAllOptions
(NumericFilterSelectAllOptions selectAllOptions) Select all of the values.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
-
filterId
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
- Parameters:
filterId
- An identifier that uniquely identifies a filter within a dashboard, analysis, or template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
column
The column that the filter is applied to.
- Parameters:
column
- The column that the filter is applied to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
column
The column that the filter is applied to.
This is a convenience method that creates an instance of theColumnIdentifier.Builder
avoiding the need to create one manually viaColumnIdentifier.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocolumn(ColumnIdentifier)
.- Parameters:
column
- a consumer that will call methods onColumnIdentifier.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
includeMinimum
Determines whether the minimum value in the filter value range should be included in the filtered results.
- Parameters:
includeMinimum
- Determines whether the minimum value in the filter value range should be included in the filtered results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeMaximum
Determines whether the maximum value in the filter value range should be included in the filtered results.
- Parameters:
includeMaximum
- Determines whether the maximum value in the filter value range should be included in the filtered results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rangeMinimum
The minimum value for the filter value range.
- Parameters:
rangeMinimum
- The minimum value for the filter value range.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rangeMinimum
default NumericRangeFilter.Builder rangeMinimum(Consumer<NumericRangeFilterValue.Builder> rangeMinimum) The minimum value for the filter value range.
This is a convenience method that creates an instance of theNumericRangeFilterValue.Builder
avoiding the need to create one manually viaNumericRangeFilterValue.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torangeMinimum(NumericRangeFilterValue)
.- Parameters:
rangeMinimum
- a consumer that will call methods onNumericRangeFilterValue.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
rangeMaximum
The maximum value for the filter value range.
- Parameters:
rangeMaximum
- The maximum value for the filter value range.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rangeMaximum
default NumericRangeFilter.Builder rangeMaximum(Consumer<NumericRangeFilterValue.Builder> rangeMaximum) The maximum value for the filter value range.
This is a convenience method that creates an instance of theNumericRangeFilterValue.Builder
avoiding the need to create one manually viaNumericRangeFilterValue.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torangeMaximum(NumericRangeFilterValue)
.- Parameters:
rangeMaximum
- a consumer that will call methods onNumericRangeFilterValue.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
selectAllOptions
Select all of the values. Null is not the assigned value of select all.
-
FILTER_ALL_VALUES
- Parameters:
selectAllOptions
- Select all of the values. Null is not the assigned value of select all.-
FILTER_ALL_VALUES
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
selectAllOptions
Select all of the values. Null is not the assigned value of select all.
-
FILTER_ALL_VALUES
- Parameters:
selectAllOptions
- Select all of the values. Null is not the assigned value of select all.-
FILTER_ALL_VALUES
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
aggregationFunction
The aggregation function of the filter.
- Parameters:
aggregationFunction
- The aggregation function of the filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aggregationFunction
default NumericRangeFilter.Builder aggregationFunction(Consumer<AggregationFunction.Builder> aggregationFunction) The aggregation function of the filter.
This is a convenience method that creates an instance of theAggregationFunction.Builder
avoiding the need to create one manually viaAggregationFunction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaggregationFunction(AggregationFunction)
.- Parameters:
aggregationFunction
- a consumer that will call methods onAggregationFunction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nullOption
This option determines how null values should be treated when filtering data.
-
ALL_VALUES
: Include null values in filtered results. -
NULLS_ONLY
: Only include null values in filtered results. -
NON_NULLS_ONLY
: Exclude null values from filtered results.
- Parameters:
nullOption
- This option determines how null values should be treated when filtering data.-
ALL_VALUES
: Include null values in filtered results. -
NULLS_ONLY
: Only include null values in filtered results. -
NON_NULLS_ONLY
: Exclude null values from filtered results.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
nullOption
This option determines how null values should be treated when filtering data.
-
ALL_VALUES
: Include null values in filtered results. -
NULLS_ONLY
: Only include null values in filtered results. -
NON_NULLS_ONLY
: Exclude null values from filtered results.
- Parameters:
nullOption
- This option determines how null values should be treated when filtering data.-
ALL_VALUES
: Include null values in filtered results. -
NULLS_ONLY
: Only include null values in filtered results. -
NON_NULLS_ONLY
: Exclude null values from filtered results.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
defaultFilterControlConfiguration
NumericRangeFilter.Builder defaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration) The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
- Parameters:
defaultFilterControlConfiguration
- The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultFilterControlConfiguration
default NumericRangeFilter.Builder defaultFilterControlConfiguration(Consumer<DefaultFilterControlConfiguration.Builder> defaultFilterControlConfiguration) The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
This is a convenience method that creates an instance of theDefaultFilterControlConfiguration.Builder
avoiding the need to create one manually viaDefaultFilterControlConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultFilterControlConfiguration(DefaultFilterControlConfiguration)
.- Parameters:
defaultFilterControlConfiguration
- a consumer that will call methods onDefaultFilterControlConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-