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

Class NumericRangeFilter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.NumericRangeFilter

All Implemented Interfaces:

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

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

A NumericRangeFilter filters values that are within the value range.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NumericRangeFilter.Builder

Method Summary

Modifier and Type	Method	Description
AggregationFunction	aggregationFunction()	The aggregation function of the filter.
static NumericRangeFilter.Builder	builder()
ColumnIdentifier	column()	The column that the filter is applied to.
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()
Boolean	includeMaximum()	Determines whether the maximum value in the filter value range should be included in the filtered results.
Boolean	includeMinimum()	Determines whether the minimum value in the filter value range should be included in the filtered results.
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.
NumericRangeFilterValue	rangeMaximum()	The maximum value for the filter value range.
NumericRangeFilterValue	rangeMinimum()	The minimum value for the filter value range.
List<SdkField<?>>	sdkFields()
NumericFilterSelectAllOptions	selectAllOptions()	Select all of the values.
String	selectAllOptionsAsString()	Select all of the values.
static Class<? extends NumericRangeFilter.Builder>	serializableBuilderClass()
NumericRangeFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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.

includeMinimum

public final Boolean includeMinimum()

Determines whether the minimum value in the filter value range should be included in the filtered results.

Returns:

Determines whether the minimum value in the filter value range should be included in the filtered results.

includeMaximum

public final Boolean includeMaximum()

Determines whether the maximum value in the filter value range should be included in the filtered results.

Returns:

Determines whether the maximum value in the filter value range should be included in the filtered results.

rangeMinimum

public final NumericRangeFilterValue rangeMinimum()

The minimum value for the filter value range.

Returns:

The minimum value for the filter value range.

rangeMaximum

public final NumericRangeFilterValue rangeMaximum()

The maximum value for the filter value range.

Returns:

The maximum value for the filter value range.

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

aggregationFunction

public final AggregationFunction aggregationFunction()

The aggregation function of the filter.

Returns:

The aggregation function of the filter.

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

toBuilder

public NumericRangeFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NumericRangeFilter.Builder,NumericRangeFilter>

builder

public static NumericRangeFilter.Builder builder()

serializableBuilderClass

public static Class<? extends NumericRangeFilter.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