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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public TopicNumericRangeFilter.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TopicNumericRangeFilter.Builder,TopicNumericRangeFilter>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.