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

Class CategoryFilter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.CategoryFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CategoryFilter.Builder,CategoryFilter>

@Generated("software.amazon.awssdk:codegen")
public final class CategoryFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CategoryFilter.Builder,CategoryFilter>

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CategoryFilter.Builder

Method Summary

Modifier and Type	Method	Description
static CategoryFilter.Builder	builder()
ColumnIdentifier	column()	The column that the filter is applied to.
CategoryFilterConfiguration	configuration()	The configuration for a CategoryFilter.
DefaultFilterControlConfiguration	defaultFilterControlConfiguration()	The default configurations for the associated controls.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CategoryFilter.Builder>	serializableBuilderClass()
CategoryFilter.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

filterId

public final String filterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Returns:

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

column

public final ColumnIdentifier column()

The column that the filter is applied to.

Returns:

The column that the filter is applied to.

configuration

public final CategoryFilterConfiguration configuration()

The configuration for a CategoryFilter.

Returns:

The configuration for a CategoryFilter.

defaultFilterControlConfiguration

public final DefaultFilterControlConfiguration defaultFilterControlConfiguration()

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Returns:

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

toBuilder

public CategoryFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CategoryFilter.Builder,CategoryFilter>

builder

public static CategoryFilter.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo