CustomFilterListConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.CustomFilterListConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CustomFilterListConfiguration.Builder,CustomFilterListConfiguration>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CustomFilterListConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CustomFilterListConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CustomFilterListConfiguration.Builder`	`builder()`
`List<String>`	`categoryValues()` The list of category values for the filter.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCategoryValues()` For responses, this returns true if the service returned a value for the CategoryValues property.
`int`	`hashCode()`
`CategoryFilterMatchOperator`	`matchOperator()` The match operator that is used to determine if a filter should be applied.
`String`	`matchOperatorAsString()` The match operator that is used to determine if a filter should be applied.
`FilterNullOption`	`nullOption()` This option determines how null values should be treated when filtering data.
`String`	`nullOptionAsString()` This option determines how null values should be treated when filtering data.
`List<SdkField<?>>`	`sdkFields()`
`CategoryFilterSelectAllOptions`	`selectAllOptions()` Select all of the values.
`String`	`selectAllOptionsAsString()` Select all of the values.
`static Class<? extends CustomFilterListConfiguration.Builder>`	`serializableBuilderClass()`
`CustomFilterListConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    CategoryFilterMatchOperator
  - 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:
    
    CategoryFilterMatchOperator
  - 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:
    
    CategoryFilterSelectAllOptions
  - 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:
    
    CategoryFilterSelectAllOptions
  - 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:
    
    FilterNullOption
  - 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:
    
    FilterNullOption
  - toBuilder
```
public CustomFilterListConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CustomFilterListConfiguration.Builder,CustomFilterListConfiguration>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class CustomFilterListConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

matchOperator

matchOperatorAsString

hasCategoryValues

categoryValues

selectAllOptions

selectAllOptionsAsString

nullOption

nullOptionAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields