software.amazon.awssdk.services.quicksight.model

Class Filter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.Filter

All Implemented Interfaces:

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

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

With a Filter, you can remove portions of data from a particular visual or view.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Filter.Builder

Method Summary

Modifier and Type	Method and Description
static Filter.Builder	builder()
CategoryFilter	categoryFilter() A CategoryFilter filters text values.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NumericEqualityFilter	numericEqualityFilter() A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
NumericRangeFilter	numericRangeFilter() A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
RelativeDatesFilter	relativeDatesFilter() A RelativeDatesFilter filters date values that are relative to a given date.
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
TimeEqualityFilter	timeEqualityFilter() A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
TimeRangeFilter	timeRangeFilter() A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
Filter.Builder	toBuilder()
TopBottomFilter	topBottomFilter() A TopBottomFilter filters data to the top or bottom values for a given column.
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

categoryFilter

public final CategoryFilter categoryFilter()

A CategoryFilter filters text values.

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

Returns:

A CategoryFilter filters text values.

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

numericRangeFilter

public final NumericRangeFilter numericRangeFilter()

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

Returns:

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

numericEqualityFilter

public final NumericEqualityFilter numericEqualityFilter()

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

Returns:

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

timeEqualityFilter

public final TimeEqualityFilter timeEqualityFilter()

A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

Returns:

A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

timeRangeFilter

public final TimeRangeFilter timeRangeFilter()

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

Returns:

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

relativeDatesFilter

public final RelativeDatesFilter relativeDatesFilter()

A RelativeDatesFilter filters date values that are relative to a given date.

Returns:

A RelativeDatesFilter filters date values that are relative to a given date.

topBottomFilter

public final TopBottomFilter topBottomFilter()

A TopBottomFilter filters data to the top or bottom values for a given column.

Returns:

A TopBottomFilter filters data to the top or bottom values for a given column.

toBuilder

public Filter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>

builder

public static Filter.Builder builder()

serializableBuilderClass

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