Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.DrillDownFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.DrillDownFilterProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

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

The drill down filter for the column hierarchies.

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.*;
 DrillDownFilterProperty drillDownFilterProperty = DrillDownFilterProperty.builder()
         .categoryFilter(CategoryDrillDownFilterProperty.builder()
                 .categoryValues(List.of("categoryValues"))
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .build())
         .numericEqualityFilter(NumericEqualityDrillDownFilterProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .value(123)
                 .build())
         .timeRangeFilter(TimeRangeDrillDownFilterProperty.builder()
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .rangeMaximum("rangeMaximum")
                 .rangeMinimum("rangeMinimum")
                 .timeGranularity("timeGranularity")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.DrillDownFilterProperty.Builder	builder()
default Object	getCategoryFilter()	The category type drill down filter.
default Object	getNumericEqualityFilter()	The numeric equality type drill down filter.
default Object	getTimeRangeFilter()	The time range drill down filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCategoryFilter

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

The category type drill down filter.

This filter is used for string type columns.

getNumericEqualityFilter

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

The numeric equality type drill down filter.

This filter is used for number type columns.

getTimeRangeFilter

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

The time range drill down filter.

This filter is used for date time columns.

builder

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

Returns:

a CfnTemplate.DrillDownFilterProperty.Builder of CfnTemplate.DrillDownFilterProperty