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

Class CustomFilterConfiguration

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

A custom filter that filters based on a single value. This filter can be partially matched.

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:

    • categoryValue

      public final String categoryValue()

      The category value for the filter.

      This field is mutually exclusive to ParameterName.

      Returns:
      The category value for the filter.

      This field is mutually exclusive to ParameterName.

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

    • parameterName

      public final String parameterName()

      The parameter whose value should be used for the filter value.

      This field is mutually exclusive to CategoryValue.

      Returns:
      The parameter whose value should be used for the filter value.

      This field is mutually exclusive to CategoryValue.

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

    • builder

      public static CustomFilterConfiguration.Builder builder()

    • serializableBuilderClass

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