Package software.amazon.awssdk.services.quicksight.model

Interface NumericRangeFilter.Builder

All Superinterfaces:

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

Enclosing class:

NumericRangeFilter

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

Method Summary

Modifier and Type	Method	Description
default NumericRangeFilter.Builder	aggregationFunction(Consumer<AggregationFunction.Builder> aggregationFunction)	The aggregation function of the filter.
NumericRangeFilter.Builder	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.
NumericRangeFilter.Builder	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.
NumericRangeFilter.Builder	defaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)	The default configurations for the associated controls.
NumericRangeFilter.Builder	filterId(String filterId)	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
NumericRangeFilter.Builder	includeMaximum(Boolean includeMaximum)	Determines whether the maximum value in the filter value range should be included in the filtered results.
NumericRangeFilter.Builder	includeMinimum(Boolean includeMinimum)	Determines whether the minimum value in the filter value range should be included in the filtered results.
NumericRangeFilter.Builder	nullOption(String nullOption)	This option determines how null values should be treated when filtering data.
NumericRangeFilter.Builder	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.
NumericRangeFilter.Builder	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.
NumericRangeFilter.Builder	rangeMinimum(NumericRangeFilterValue rangeMinimum)	The minimum value for the filter value range.
NumericRangeFilter.Builder	selectAllOptions(String selectAllOptions)	Select all of the values.
NumericRangeFilter.Builder	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, sdkFieldNameToField, sdkFields

Method Detail

filterId

NumericRangeFilter.Builder filterId(String 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

NumericRangeFilter.Builder column(ColumnIdentifier 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

default NumericRangeFilter.Builder column(Consumer<ColumnIdentifier.Builder> column)

The column that the filter is applied to.

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

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

Parameters:

column - a consumer that will call methods on ColumnIdentifier.Builder

Returns:

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

See Also:

column(ColumnIdentifier)

includeMinimum

NumericRangeFilter.Builder includeMinimum(Boolean 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

NumericRangeFilter.Builder includeMaximum(Boolean 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

NumericRangeFilter.Builder rangeMinimum(NumericRangeFilterValue 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 the NumericRangeFilterValue.Builder avoiding the need to create one manually via NumericRangeFilterValue.builder().

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

Parameters:

rangeMinimum - a consumer that will call methods on NumericRangeFilterValue.Builder

Returns:

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

See Also:

rangeMinimum(NumericRangeFilterValue)

rangeMaximum

NumericRangeFilter.Builder rangeMaximum(NumericRangeFilterValue 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 the NumericRangeFilterValue.Builder avoiding the need to create one manually via NumericRangeFilterValue.builder().

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

Parameters:

rangeMaximum - a consumer that will call methods on NumericRangeFilterValue.Builder

Returns:

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

See Also:

rangeMaximum(NumericRangeFilterValue)

selectAllOptions

NumericRangeFilter.Builder selectAllOptions(String 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:

NumericFilterSelectAllOptions, NumericFilterSelectAllOptions

selectAllOptions

NumericRangeFilter.Builder selectAllOptions(NumericFilterSelectAllOptions 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:

NumericFilterSelectAllOptions, NumericFilterSelectAllOptions

aggregationFunction

NumericRangeFilter.Builder aggregationFunction(AggregationFunction 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 the AggregationFunction.Builder avoiding the need to create one manually via AggregationFunction.builder().

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

Parameters:

aggregationFunction - a consumer that will call methods on AggregationFunction.Builder

Returns:

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

See Also:

aggregationFunction(AggregationFunction)

nullOption

NumericRangeFilter.Builder nullOption(String 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:

FilterNullOption, FilterNullOption

nullOption

NumericRangeFilter.Builder nullOption(FilterNullOption 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:

FilterNullOption, FilterNullOption

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 the DefaultFilterControlConfiguration.Builder avoiding the need to create one manually via DefaultFilterControlConfiguration.builder().

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

Parameters:

defaultFilterControlConfiguration - a consumer that will call methods on DefaultFilterControlConfiguration.Builder

Returns:

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

See Also:

defaultFilterControlConfiguration(DefaultFilterControlConfiguration)