Package software.amazon.awscdk.services.quicksight

Interface CfnAnalysis.NestedFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysis.NestedFilterProperty.Jsii$Proxy

Enclosing class:

CfnAnalysis

@Stability(Stable)
public static interface CfnAnalysis.NestedFilterProperty
extends software.amazon.jsii.JsiiSerializable

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

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.*;
 NestedFilterProperty nestedFilterProperty = NestedFilterProperty.builder()
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         .includeInnerSet(false)
         .innerFilter(InnerFilterProperty.builder()
                 .categoryInnerFilter(CategoryInnerFilterProperty.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())
                         // the properties below are optional
                         .defaultFilterControlConfiguration(DefaultFilterControlConfigurationProperty.builder()
                                 .controlOptions(DefaultFilterControlOptionsProperty.builder()
                                         .defaultDateTimePickerOptions(DefaultDateTimePickerControlOptionsProperty.builder()
                                                 .commitMode("commitMode")
                                                 .displayOptions(DateTimePickerControlDisplayOptionsProperty.builder()
                                                         .dateTimeFormat("dateTimeFormat")
                                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                                 .infoIconText("infoIconText")
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .titleOptions(LabelOptionsProperty.builder()
                                                                 .customLabel("customLabel")
                                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                                         .fontColor("fontColor")
                                                                         .fontDecoration("fontDecoration")
                                                                         .fontSize(FontSizeProperty.builder()
                                                                                 .relative("relative")
                                                                                 .build())
                                                                         .fontStyle("fontStyle")
                                                                         .fontWeight(FontWeightProperty.builder()
                                                                                 .name("name")
                                                                                 .build())
                                                                         .build())
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .build())
                                                 .type("type")
                                                 .build())
                                         .defaultDropdownOptions(DefaultFilterDropDownControlOptionsProperty.builder()
                                                 .commitMode("commitMode")
                                                 .displayOptions(DropDownControlDisplayOptionsProperty.builder()
                                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                                 .infoIconText("infoIconText")
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .selectAllOptions(ListControlSelectAllOptionsProperty.builder()
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .titleOptions(LabelOptionsProperty.builder()
                                                                 .customLabel("customLabel")
                                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                                         .fontColor("fontColor")
                                                                         .fontDecoration("fontDecoration")
                                                                         .fontSize(FontSizeProperty.builder()
                                                                                 .relative("relative")
                                                                                 .build())
                                                                         .fontStyle("fontStyle")
                                                                         .fontWeight(FontWeightProperty.builder()
                                                                                 .name("name")
                                                                                 .build())
                                                                         .build())
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .build())
                                                 .selectableValues(FilterSelectableValuesProperty.builder()
                                                         .values(List.of("values"))
                                                         .build())
                                                 .type("type")
                                                 .build())
                                         .defaultListOptions(DefaultFilterListControlOptionsProperty.builder()
                                                 .displayOptions(ListControlDisplayOptionsProperty.builder()
                                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                                 .infoIconText("infoIconText")
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .searchOptions(ListControlSearchOptionsProperty.builder()
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .selectAllOptions(ListControlSelectAllOptionsProperty.builder()
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .titleOptions(LabelOptionsProperty.builder()
                                                                 .customLabel("customLabel")
                                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                                         .fontColor("fontColor")
                                                                         .fontDecoration("fontDecoration")
                                                                         .fontSize(FontSizeProperty.builder()
                                                                                 .relative("relative")
                                                                                 .build())
                                                                         .fontStyle("fontStyle")
                                                                         .fontWeight(FontWeightProperty.builder()
                                                                                 .name("name")
                                                                                 .build())
                                                                         .build())
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .build())
                                                 .selectableValues(FilterSelectableValuesProperty.builder()
                                                         .values(List.of("values"))
                                                         .build())
                                                 .type("type")
                                                 .build())
                                         .defaultRelativeDateTimeOptions(DefaultRelativeDateTimeControlOptionsProperty.builder()
                                                 .commitMode("commitMode")
                                                 .displayOptions(RelativeDateTimeControlDisplayOptionsProperty.builder()
                                                         .dateTimeFormat("dateTimeFormat")
                                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                                 .infoIconText("infoIconText")
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .titleOptions(LabelOptionsProperty.builder()
                                                                 .customLabel("customLabel")
                                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                                         .fontColor("fontColor")
                                                                         .fontDecoration("fontDecoration")
                                                                         .fontSize(FontSizeProperty.builder()
                                                                                 .relative("relative")
                                                                                 .build())
                                                                         .fontStyle("fontStyle")
                                                                         .fontWeight(FontWeightProperty.builder()
                                                                                 .name("name")
                                                                                 .build())
                                                                         .build())
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .defaultSliderOptions(DefaultSliderControlOptionsProperty.builder()
                                                 .maximumValue(123)
                                                 .minimumValue(123)
                                                 .stepSize(123)
                                                 // the properties below are optional
                                                 .displayOptions(SliderControlDisplayOptionsProperty.builder()
                                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                                 .infoIconText("infoIconText")
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .titleOptions(LabelOptionsProperty.builder()
                                                                 .customLabel("customLabel")
                                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                                         .fontColor("fontColor")
                                                                         .fontDecoration("fontDecoration")
                                                                         .fontSize(FontSizeProperty.builder()
                                                                                 .relative("relative")
                                                                                 .build())
                                                                         .fontStyle("fontStyle")
                                                                         .fontWeight(FontWeightProperty.builder()
                                                                                 .name("name")
                                                                                 .build())
                                                                         .build())
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .build())
                                                 .type("type")
                                                 .build())
                                         .defaultTextAreaOptions(DefaultTextAreaControlOptionsProperty.builder()
                                                 .delimiter("delimiter")
                                                 .displayOptions(TextAreaControlDisplayOptionsProperty.builder()
                                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                                 .infoIconText("infoIconText")
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .titleOptions(LabelOptionsProperty.builder()
                                                                 .customLabel("customLabel")
                                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                                         .fontColor("fontColor")
                                                                         .fontDecoration("fontDecoration")
                                                                         .fontSize(FontSizeProperty.builder()
                                                                                 .relative("relative")
                                                                                 .build())
                                                                         .fontStyle("fontStyle")
                                                                         .fontWeight(FontWeightProperty.builder()
                                                                                 .name("name")
                                                                                 .build())
                                                                         .build())
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .defaultTextFieldOptions(DefaultTextFieldControlOptionsProperty.builder()
                                                 .displayOptions(TextFieldControlDisplayOptionsProperty.builder()
                                                         .infoIconLabelOptions(SheetControlInfoIconLabelOptionsProperty.builder()
                                                                 .infoIconText("infoIconText")
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .placeholderOptions(TextControlPlaceholderOptionsProperty.builder()
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .titleOptions(LabelOptionsProperty.builder()
                                                                 .customLabel("customLabel")
                                                                 .fontConfiguration(FontConfigurationProperty.builder()
                                                                         .fontColor("fontColor")
                                                                         .fontDecoration("fontDecoration")
                                                                         .fontSize(FontSizeProperty.builder()
                                                                                 .relative("relative")
                                                                                 .build())
                                                                         .fontStyle("fontStyle")
                                                                         .fontWeight(FontWeightProperty.builder()
                                                                                 .name("name")
                                                                                 .build())
                                                                         .build())
                                                                 .visibility("visibility")
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .build())
                                 .title("title")
                                 .build())
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAnalysis.NestedFilterProperty.Builder	builder()
Object	getColumn()	The column that the filter is applied to.
String	getFilterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Object	getIncludeInnerSet()	A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.
Object	getInnerFilter()	The InnerFilter defines the subset of data to be used with the NestedFilter .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumn

@Stability(Stable)
@NotNull
Object getColumn()

The column that the filter is applied to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html#cfn-quicksight-analysis-nestedfilter-column

getFilterId

@Stability(Stable)
@NotNull
String getFilterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html#cfn-quicksight-analysis-nestedfilter-filterid

getIncludeInnerSet

@Stability(Stable)
@NotNull
Object getIncludeInnerSet()

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html#cfn-quicksight-analysis-nestedfilter-includeinnerset

getInnerFilter

@Stability(Stable)
@NotNull
Object getInnerFilter()

The InnerFilter defines the subset of data to be used with the NestedFilter .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-nestedfilter.html#cfn-quicksight-analysis-nestedfilter-innerfilter

builder

@Stability(Stable)
static CfnAnalysis.NestedFilterProperty.Builder builder()

Returns:

a CfnAnalysis.NestedFilterProperty.Builder of CfnAnalysis.NestedFilterProperty