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

Class CustomFilterListConfiguration

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

A list of custom filter values.

See Also:

  • Method Details

    • matchOperator

      public final CategoryFilterMatchOperator matchOperator()

      The match operator that is used to determine if a filter should be applied.

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

      Returns:
      The match operator that is used to determine if a filter should be applied.
      See Also:

    • matchOperatorAsString

      public final String matchOperatorAsString()

      The match operator that is used to determine if a filter should be applied.

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

      Returns:
      The match operator that is used to determine if a filter should be applied.
      See Also:

    • hasCategoryValues

      public final boolean hasCategoryValues()
      For responses, this returns true if the service returned a value for the CategoryValues 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.

    • categoryValues

      public final List<String> categoryValues()

      The list of category values 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 hasCategoryValues() method.

      Returns:
      The list of category values for the filter.

    • selectAllOptions

      public final CategoryFilterSelectAllOptions 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 CategoryFilterSelectAllOptions.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:

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

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

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

    • toBuilder

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

    • builder

      public static CustomFilterListConfiguration.Builder builder()

    • serializableBuilderClass

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