Interface CfnTemplate.FilterGroupProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.FilterGroupProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.FilterGroupProperty
extends software.amazon.jsii.JsiiSerializable
A grouping of individual filters. Filter groups are applied to the same group of visuals.
For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide .
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.*;
Object allSheets;
FilterGroupProperty filterGroupProperty = FilterGroupProperty.builder()
.crossDataset("crossDataset")
.filterGroupId("filterGroupId")
.filters(List.of(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()))
.scopeConfiguration(FilterScopeConfigurationProperty.builder()
.allSheets(allSheets)
.selectedSheets(SelectedSheetsFilterScopeConfigurationProperty.builder()
.sheetVisualScopingConfigurations(List.of(SheetVisualScopingConfigurationProperty.builder()
.scope("scope")
.sheetId("sheetId")
// the properties below are optional
.visualIds(List.of("visualIds"))
.build()))
.build())
.build())
// the properties below are optional
.status("status")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnTemplate.FilterGroupPropertystatic final classAn implementation forCfnTemplate.FilterGroupProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The filter new feature which can apply filter group to all data sets.The value that uniquely identifies aFilterGroupwithin a dashboard, template, or analysis.The list of filters that are present in aFilterGroup.The configuration that specifies what scope to apply to aFilterGroup.default StringThe status of theFilterGroup.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCrossDataset
The filter new feature which can apply filter group to all data sets. Choose one of the following options:.ALL_DATASETSSINGLE_DATASET
- See Also:
-
getFilterGroupId
The value that uniquely identifies aFilterGroupwithin a dashboard, template, or analysis.- See Also:
-
getFilters
The list of filters that are present in aFilterGroup.- See Also:
-
getScopeConfiguration
The configuration that specifies what scope to apply to aFilterGroup.This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
- See Also:
-
getStatus
The status of theFilterGroup.- See Also:
-
builder
-