Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.FilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.FilterProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.FilterProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplate.FilterProperty.Builder	A builder for CfnTemplate.FilterProperty
static final class	CfnTemplate.FilterProperty.Jsii$Proxy	An implementation for CfnTemplate.FilterProperty

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.FilterProperty.Builder	builder()
default Object	getCategoryFilter()	A CategoryFilter filters text values.
default Object	getNumericEqualityFilter()	A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
default Object	getNumericRangeFilter()	A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
default Object	getRelativeDatesFilter()	A RelativeDatesFilter filters date values that are relative to a given date.
default Object	getTimeEqualityFilter()	A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
default Object	getTimeRangeFilter()	A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
default Object	getTopBottomFilter()	A TopBottomFilter filters data to the top or bottom values for a given column.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCategoryFilter

@Stability(Stable)
@Nullable
default Object getCategoryFilter()

A CategoryFilter filters text values.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-categoryfilter

getNumericEqualityFilter

@Stability(Stable)
@Nullable
default Object getNumericEqualityFilter()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-numericequalityfilter

getNumericRangeFilter

@Stability(Stable)
@Nullable
default Object getNumericRangeFilter()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-numericrangefilter

getRelativeDatesFilter

@Stability(Stable)
@Nullable
default Object getRelativeDatesFilter()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-relativedatesfilter

getTimeEqualityFilter

@Stability(Stable)
@Nullable
default Object getTimeEqualityFilter()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-timeequalityfilter

getTimeRangeFilter

@Stability(Stable)
@Nullable
default Object getTimeRangeFilter()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-timerangefilter

getTopBottomFilter

@Stability(Stable)
@Nullable
default Object getTopBottomFilter()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filter.html#cfn-quicksight-template-filter-topbottomfilter

builder

@Stability(Stable)
static CfnTemplate.FilterProperty.Builder builder()

Returns:

a CfnTemplate.FilterProperty.Builder of CfnTemplate.FilterProperty