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

Class TopicNumericRangeFilter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.TopicNumericRangeFilter

All Implemented Interfaces:

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

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

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TopicNumericRangeFilter.Builder

Method Summary

Modifier and Type	Method	Description
NamedFilterAggType	aggregation()	An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
String	aggregationAsString()	An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
static TopicNumericRangeFilter.Builder	builder()
TopicRangeFilterConstant	constant()	The constant used in a numeric range filter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	inclusive()	A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TopicNumericRangeFilter.Builder>	serializableBuilderClass()
TopicNumericRangeFilter.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

inclusive

public final Boolean inclusive()

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

Returns:

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

constant

public final TopicRangeFilterConstant constant()

The constant used in a numeric range filter.

Returns:

The constant used in a numeric range filter.

aggregation

public final NamedFilterAggType aggregation()

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

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

Returns:

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

See Also:

NamedFilterAggType

aggregationAsString

public final String aggregationAsString()

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

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

Returns:

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

See Also:

NamedFilterAggType

toBuilder

public TopicNumericRangeFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TopicNumericRangeFilter.Builder,TopicNumericRangeFilter>

builder

public static TopicNumericRangeFilter.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo