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

Class TopicFilter

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

A structure that represents a filter used to select items for a topic.

See Also:

  • Method Details

    • filterDescription

      public final String filterDescription()

      A description of the filter used to select items for a topic.

      Returns:
      A description of the filter used to select items for a topic.

    • filterClass

      public final FilterClass filterClass()

      The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

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

      Returns:
      The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.
      See Also:

    • filterClassAsString

      public final String filterClassAsString()

      The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

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

      Returns:
      The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.
      See Also:

    • filterName

      public final String filterName()

      The name of the filter.

      Returns:
      The name of the filter.

    • hasFilterSynonyms

      public final boolean hasFilterSynonyms()
      For responses, this returns true if the service returned a value for the FilterSynonyms property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filterSynonyms

      public final List<String> filterSynonyms()

      The other names or aliases for the filter.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilterSynonyms() method.

      Returns:
      The other names or aliases for the filter.

    • operandFieldName

      public final String operandFieldName()

      The name of the field that the filter operates on.

      Returns:
      The name of the field that the filter operates on.

    • filterType

      public final NamedFilterType filterType()

      The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

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

      Returns:
      The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.
      See Also:

    • filterTypeAsString

      public final String filterTypeAsString()

      The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

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

      Returns:
      The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.
      See Also:

    • categoryFilter

      public final TopicCategoryFilter categoryFilter()

      The category filter that is associated with this filter.

      Returns:
      The category filter that is associated with this filter.

    • numericEqualityFilter

      public final TopicNumericEqualityFilter numericEqualityFilter()

      The numeric equality filter.

      Returns:
      The numeric equality filter.

    • numericRangeFilter

      public final TopicNumericRangeFilter numericRangeFilter()

      The numeric range filter.

      Returns:
      The numeric range filter.

    • dateRangeFilter

      public final TopicDateRangeFilter dateRangeFilter()

      The date range filter.

      Returns:
      The date range filter.

    • relativeDateFilter

      public final TopicRelativeDateFilter relativeDateFilter()

      The relative date filter.

      Returns:
      The relative date filter.

    • toBuilder

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

    • builder

      public static TopicFilter.Builder builder()

    • serializableBuilderClass

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