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

Class NumericEqualityFilter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.NumericEqualityFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NumericEqualityFilter.Builder,NumericEqualityFilter>

@Generated("software.amazon.awssdk:codegen")
public final class NumericEqualityFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NumericEqualityFilter.Builder,NumericEqualityFilter>

A NumericEqualityFilter filters values that are equal to the specified value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NumericEqualityFilter.Builder

Method Summary

Modifier and Type	Method	Description
AggregationFunction	aggregationFunction()	The aggregation function of the filter.
static NumericEqualityFilter.Builder	builder()
ColumnIdentifier	column()	The column that the filter is applied to.
DefaultFilterControlConfiguration	defaultFilterControlConfiguration()	The default configurations for the associated controls.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NumericEqualityMatchOperator	matchOperator()	The match operator that is used to determine if a filter should be applied.
String	matchOperatorAsString()	The match operator that is used to determine if a filter should be applied.
FilterNullOption	nullOption()	This option determines how null values should be treated when filtering data.
String	nullOptionAsString()	This option determines how null values should be treated when filtering data.
String	parameterName()	The parameter whose value should be used for the filter value.
List<SdkField<?>>	sdkFields()
NumericFilterSelectAllOptions	selectAllOptions()	Select all of the values.
String	selectAllOptionsAsString()	Select all of the values.
static Class<? extends NumericEqualityFilter.Builder>	serializableBuilderClass()
NumericEqualityFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Double	value()	The input value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

filterId

public final String filterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Returns:

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

column

public final ColumnIdentifier column()

The column that the filter is applied to.

Returns:

The column that the filter is applied to.

value

public final Double value()

The input value.

Returns:

The input value.

selectAllOptions

public final NumericFilterSelectAllOptions selectAllOptions()

Select all of the values. Null is not the assigned value of select all.

• FILTER_ALL_VALUES

If the service returns an enum value that is not available in the current SDK version, selectAllOptions will return NumericFilterSelectAllOptions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectAllOptionsAsString().

Returns:

Select all of the values. Null is not the assigned value of select all.

• FILTER_ALL_VALUES

See Also:

NumericFilterSelectAllOptions

selectAllOptionsAsString

public final String selectAllOptionsAsString()

Select all of the values. Null is not the assigned value of select all.

• FILTER_ALL_VALUES

If the service returns an enum value that is not available in the current SDK version, selectAllOptions will return NumericFilterSelectAllOptions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectAllOptionsAsString().

Returns:

Select all of the values. Null is not the assigned value of select all.

• FILTER_ALL_VALUES

See Also:

NumericFilterSelectAllOptions

matchOperator

public final NumericEqualityMatchOperator matchOperator()

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

If the service returns an enum value that is not available in the current SDK version, matchOperator will return NumericEqualityMatchOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchOperatorAsString().

Returns:

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

See Also:

NumericEqualityMatchOperator

matchOperatorAsString

public final String matchOperatorAsString()

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

If the service returns an enum value that is not available in the current SDK version, matchOperator will return NumericEqualityMatchOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from matchOperatorAsString().

Returns:

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

See Also:

NumericEqualityMatchOperator

aggregationFunction

public final AggregationFunction aggregationFunction()

The aggregation function of the filter.

Returns:

The aggregation function of the filter.

parameterName

public final String parameterName()

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

Returns:

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

nullOption

public final 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.

If the service returns an enum value that is not available in the current SDK version, nullOption will return FilterNullOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nullOptionAsString().

Returns:

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.

See Also:

FilterNullOption

nullOptionAsString

public final String nullOptionAsString()

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.

If the service returns an enum value that is not available in the current SDK version, nullOption will return FilterNullOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nullOptionAsString().

Returns:

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.

See Also:

FilterNullOption

defaultFilterControlConfiguration

public final DefaultFilterControlConfiguration defaultFilterControlConfiguration()

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Returns:

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

toBuilder

public NumericEqualityFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NumericEqualityFilter.Builder,NumericEqualityFilter>

builder

public static NumericEqualityFilter.Builder builder()

serializableBuilderClass

public static Class<? extends NumericEqualityFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo