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:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 FilterProperty filterProperty = FilterProperty.builder()
         .categoryFilter(CategoryFilterProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .configuration(CategoryFilterConfigurationProperty.builder()
                         .customFilterConfiguration(CustomFilterConfigurationProperty.builder()
                                 .matchOperator("matchOperator")
                                 .nullOption("nullOption")
                                 // the properties below are optional
                                 .categoryValue("categoryValue")
                                 .parameterName("parameterName")
                                 .selectAllOptions("selectAllOptions")
                                 .build())
                         .customFilterListConfiguration(CustomFilterListConfigurationProperty.builder()
                                 .matchOperator("matchOperator")
                                 .nullOption("nullOption")
                                 // the properties below are optional
                                 .categoryValues(List.of("categoryValues"))
                                 .selectAllOptions("selectAllOptions")
                                 .build())
                         .filterListConfiguration(FilterListConfigurationProperty.builder()
                                 .matchOperator("matchOperator")
                                 // the properties below are optional
                                 .categoryValues(List.of("categoryValues"))
                                 .nullOption("nullOption")
                                 .selectAllOptions("selectAllOptions")
                                 .build())
                         .build())
                 .filterId("filterId")
                 .build())
         .numericEqualityFilter(NumericEqualityFilterProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .filterId("filterId")
                 .matchOperator("matchOperator")
                 .nullOption("nullOption")
                 // the properties below are optional
                 .aggregationFunction(AggregationFunctionProperty.builder()
                         .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                 .simpleAttributeAggregation("simpleAttributeAggregation")
                                 .valueForMultipleValues("valueForMultipleValues")
                                 .build())
                         .categoricalAggregationFunction("categoricalAggregationFunction")
                         .dateAggregationFunction("dateAggregationFunction")
                         .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                 .percentileAggregation(PercentileAggregationProperty.builder()
                                         .percentileValue(123)
                                         .build())
                                 .simpleNumericalAggregation("simpleNumericalAggregation")
                                 .build())
                         .build())
                 .parameterName("parameterName")
                 .selectAllOptions("selectAllOptions")
                 .value(123)
                 .build())
         .numericRangeFilter(NumericRangeFilterProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .filterId("filterId")
                 .nullOption("nullOption")
                 // the properties below are optional
                 .aggregationFunction(AggregationFunctionProperty.builder()
                         .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                 .simpleAttributeAggregation("simpleAttributeAggregation")
                                 .valueForMultipleValues("valueForMultipleValues")
                                 .build())
                         .categoricalAggregationFunction("categoricalAggregationFunction")
                         .dateAggregationFunction("dateAggregationFunction")
                         .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                 .percentileAggregation(PercentileAggregationProperty.builder()
                                         .percentileValue(123)
                                         .build())
                                 .simpleNumericalAggregation("simpleNumericalAggregation")
                                 .build())
                         .build())
                 .includeMaximum(false)
                 .includeMinimum(false)
                 .rangeMaximum(NumericRangeFilterValueProperty.builder()
                         .parameter("parameter")
                         .staticValue(123)
                         .build())
                 .rangeMinimum(NumericRangeFilterValueProperty.builder()
                         .parameter("parameter")
                         .staticValue(123)
                         .build())
                 .selectAllOptions("selectAllOptions")
                 .build())
         .relativeDatesFilter(RelativeDatesFilterProperty.builder()
                 .anchorDateConfiguration(AnchorDateConfigurationProperty.builder()
                         .anchorOption("anchorOption")
                         .parameterName("parameterName")
                         .build())
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .filterId("filterId")
                 .nullOption("nullOption")
                 .relativeDateType("relativeDateType")
                 .timeGranularity("timeGranularity")
                 // the properties below are optional
                 .excludePeriodConfiguration(ExcludePeriodConfigurationProperty.builder()
                         .amount(123)
                         .granularity("granularity")
                         // the properties below are optional
                         .status("status")
                         .build())
                 .minimumGranularity("minimumGranularity")
                 .parameterName("parameterName")
                 .relativeDateValue(123)
                 .build())
         .timeEqualityFilter(TimeEqualityFilterProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .filterId("filterId")
                 // the properties below are optional
                 .parameterName("parameterName")
                 .rollingDate(RollingDateConfigurationProperty.builder()
                         .expression("expression")
                         // the properties below are optional
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .timeGranularity("timeGranularity")
                 .value("value")
                 .build())
         .timeRangeFilter(TimeRangeFilterProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .filterId("filterId")
                 .nullOption("nullOption")
                 // the properties below are optional
                 .excludePeriodConfiguration(ExcludePeriodConfigurationProperty.builder()
                         .amount(123)
                         .granularity("granularity")
                         // the properties below are optional
                         .status("status")
                         .build())
                 .includeMaximum(false)
                 .includeMinimum(false)
                 .rangeMaximumValue(TimeRangeFilterValueProperty.builder()
                         .parameter("parameter")
                         .rollingDate(RollingDateConfigurationProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .staticValue("staticValue")
                         .build())
                 .rangeMinimumValue(TimeRangeFilterValueProperty.builder()
                         .parameter("parameter")
                         .rollingDate(RollingDateConfigurationProperty.builder()
                                 .expression("expression")
                                 // the properties below are optional
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .staticValue("staticValue")
                         .build())
                 .timeGranularity("timeGranularity")
                 .build())
         .topBottomFilter(TopBottomFilterProperty.builder()
                 .aggregationSortConfigurations(List.of(AggregationSortConfigurationProperty.builder()
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .sortDirection("sortDirection")
                         // the properties below are optional
                         .aggregationFunction(AggregationFunctionProperty.builder()
                                 .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                         .simpleAttributeAggregation("simpleAttributeAggregation")
                                         .valueForMultipleValues("valueForMultipleValues")
                                         .build())
                                 .categoricalAggregationFunction("categoricalAggregationFunction")
                                 .dateAggregationFunction("dateAggregationFunction")
                                 .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                         .percentileAggregation(PercentileAggregationProperty.builder()
                                                 .percentileValue(123)
                                                 .build())
                                         .simpleNumericalAggregation("simpleNumericalAggregation")
                                         .build())
                                 .build())
                         .build()))
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .filterId("filterId")
                 // the properties below are optional
                 .limit(123)
                 .parameterName("parameterName")
                 .timeGranularity("timeGranularity")
                 .build())
         .build();
 

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