software.amazon.awssdk.services.quicksight.model

Interface NumericEqualityFilter.Builder

All Superinterfaces:

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

Enclosing class:

NumericEqualityFilter

public static interface NumericEqualityFilter.Builder
extends SdkPojo, CopyableBuilder<NumericEqualityFilter.Builder,NumericEqualityFilter>

Method Summary

Modifier and Type	Method and Description
NumericEqualityFilter.Builder	aggregationFunction(AggregationFunction aggregationFunction) The aggregation function of the filter.
default NumericEqualityFilter.Builder	aggregationFunction(Consumer<AggregationFunction.Builder> aggregationFunction) The aggregation function of the filter.
NumericEqualityFilter.Builder	column(ColumnIdentifier column) The column that the filter is applied to.
default NumericEqualityFilter.Builder	column(Consumer<ColumnIdentifier.Builder> column) The column that the filter is applied to.
NumericEqualityFilter.Builder	filterId(String filterId) An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
NumericEqualityFilter.Builder	matchOperator(NumericEqualityMatchOperator matchOperator) The match operator that is used to determine if a filter should be applied.
NumericEqualityFilter.Builder	matchOperator(String matchOperator) The match operator that is used to determine if a filter should be applied.
NumericEqualityFilter.Builder	nullOption(FilterNullOption nullOption) This option determines how null values should be treated when filtering data.
NumericEqualityFilter.Builder	nullOption(String nullOption) This option determines how null values should be treated when filtering data.
NumericEqualityFilter.Builder	parameterName(String parameterName) The parameter whose value should be used for the filter value.
NumericEqualityFilter.Builder	selectAllOptions(NumericFilterSelectAllOptions selectAllOptions) Select all of the values.
NumericEqualityFilter.Builder	selectAllOptions(String selectAllOptions) Select all of the values.
NumericEqualityFilter.Builder	value(Double value) The input value.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

filterId

NumericEqualityFilter.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

NumericEqualityFilter.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 NumericEqualityFilter.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)

value

NumericEqualityFilter.Builder value(Double value)

The input value.

Parameters:

value - The input value.

Returns:

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

selectAllOptions

NumericEqualityFilter.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

NumericEqualityFilter.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

matchOperator

NumericEqualityFilter.Builder matchOperator(String matchOperator)

The match operator that is used to determine if a filter should be applied.

Parameters:

matchOperator - The match operator that is used to determine if a filter should be applied.

Returns:

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

See Also:

NumericEqualityMatchOperator, NumericEqualityMatchOperator

matchOperator

NumericEqualityFilter.Builder matchOperator(NumericEqualityMatchOperator matchOperator)

The match operator that is used to determine if a filter should be applied.

Parameters:

matchOperator - The match operator that is used to determine if a filter should be applied.

Returns:

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

See Also:

NumericEqualityMatchOperator, NumericEqualityMatchOperator

aggregationFunction

NumericEqualityFilter.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 NumericEqualityFilter.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)

parameterName

NumericEqualityFilter.Builder parameterName(String parameterName)

The parameter whose value should be used for the filter value.

Parameters:

parameterName - The parameter whose value should be used for the filter value.

Returns:

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

nullOption

NumericEqualityFilter.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

NumericEqualityFilter.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