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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomFilterConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static CustomFilterConfiguration.Builder	builder()
String	categoryValue()	The category value for the filter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
String	parameterName()	The parameter whose value should be used for the filter value.
List<SdkField<?>>	sdkFields()
CategoryFilterSelectAllOptions	selectAllOptions()	Select all of the values.
String	selectAllOptionsAsString()	Select all of the values.
static Class<? extends CustomFilterConfiguration.Builder>	serializableBuilderClass()
CustomFilterConfiguration.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

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:

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

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:

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 CustomFilterConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomFilterConfiguration.Builder,CustomFilterConfiguration>

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)

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