TopicFilter (AWS Java SDK :: Services :: QuickSight 2.20.133 API)

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TopicFilter.Builder,TopicFilter>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TopicFilter.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TopicFilter.Builder`	`builder()`
`TopicCategoryFilter`	`categoryFilter()` The category filter that is associated with this filter.
`TopicDateRangeFilter`	`dateRangeFilter()` The date range filter.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FilterClass`	`filterClass()` The class of the filter.
`String`	`filterClassAsString()` The class of the filter.
`String`	`filterDescription()` A description of the filter used to select items for a topic.
`String`	`filterName()` The name of the filter.
`List<String>`	`filterSynonyms()` The other names or aliases for the filter.
`NamedFilterType`	`filterType()` The type of the filter.
`String`	`filterTypeAsString()` The type of the filter.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilterSynonyms()` For responses, this returns true if the service returned a value for the FilterSynonyms property.
`int`	`hashCode()`
`TopicNumericEqualityFilter`	`numericEqualityFilter()` The numeric equality filter.
`TopicNumericRangeFilter`	`numericRangeFilter()` The numeric range filter.
`String`	`operandFieldName()` The name of the field that the filter operates on.
`TopicRelativeDateFilter`	`relativeDateFilter()` The relative date filter.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TopicFilter.Builder>`	`serializableBuilderClass()`
`TopicFilter.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
  - 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:
    
    FilterClass
  - 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:
    
    FilterClass
  - 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:
    
    NamedFilterType
  - 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:
    
    NamedFilterType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TopicFilter.Builder,TopicFilter>
  - 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)
```
    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 TopicFilter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

filterDescription

filterClass

filterClassAsString

filterName

hasFilterSynonyms

filterSynonyms

operandFieldName

filterType

filterTypeAsString

categoryFilter

numericEqualityFilter

numericRangeFilter

dateRangeFilter

relativeDateFilter

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields