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

Class Filter

java.lang.Object
software.amazon.awssdk.services.quicksight.model.Filter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Filter.Builder,Filter>
@Generated("software.amazon.awssdk:codegen") public final class Filter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Filter.Builder,Filter>

With a Filter, you can remove portions of data from a particular visual or view.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

  • Method Details

    • categoryFilter

      public final CategoryFilter categoryFilter()

      A CategoryFilter filters text values.

      For more information, see Adding text filters in the Amazon QuickSight User Guide.

      Returns:
      A CategoryFilter filters text values.

      For more information, see Adding text filters in the Amazon QuickSight User Guide.

    • numericRangeFilter

      public final NumericRangeFilter numericRangeFilter()

      A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

      Returns:
      A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

    • numericEqualityFilter

      public final NumericEqualityFilter numericEqualityFilter()

      A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

      Returns:
      A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

    • timeEqualityFilter

      public final TimeEqualityFilter timeEqualityFilter()

      A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

      Returns:
      A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

    • timeRangeFilter

      public final TimeRangeFilter timeRangeFilter()

      A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

      Returns:
      A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

    • relativeDatesFilter

      public final RelativeDatesFilter relativeDatesFilter()

      A RelativeDatesFilter filters date values that are relative to a given date.

      Returns:
      A RelativeDatesFilter filters date values that are relative to a given date.

    • topBottomFilter

      public final TopBottomFilter topBottomFilter()

      A TopBottomFilter filters data to the top or bottom values for a given column.

      Returns:
      A TopBottomFilter filters data to the top or bottom values for a given column.

    • nestedFilter

      public final NestedFilter nestedFilter()

      A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

      Returns:
      A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

    • toBuilder

      public Filter.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<Filter.Builder,Filter>
      Returns:
      a builder for type T

    • builder

      public static Filter.Builder builder()

    • serializableBuilderClass

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