Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.TopBottomFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.TopBottomFilterProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.TopBottomFilterProperty
extends software.amazon.jsii.JsiiSerializable

A TopBottomFilter filters values that are at the top or the bottom.

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.*;
 TopBottomFilterProperty topBottomFilterProperty = TopBottomFilterProperty.builder()
         .aggregationSortConfigurations(List.of(AggregationSortConfigurationProperty.builder()
                 .aggregationFunction(AggregationFunctionProperty.builder()
                         .categoricalAggregationFunction("categoricalAggregationFunction")
                         .dateAggregationFunction("dateAggregationFunction")
                         .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                 .percentileAggregation(PercentileAggregationProperty.builder()
                                         .percentileValue(123)
                                         .build())
                                 .simpleNumericalAggregation("simpleNumericalAggregation")
                                 .build())
                         .build())
                 .column(ColumnIdentifierProperty.builder()
                         .columnName("columnName")
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .sortDirection("sortDirection")
                 .build()))
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         // the properties below are optional
         .limit(123)
         .parameterName("parameterName")
         .timeGranularity("timeGranularity")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.TopBottomFilterProperty.Builder	builder()
Object	getAggregationSortConfigurations()	The aggregation and sort configuration of the top bottom filter.
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.
default Number	getLimit()	The number of items to include in the top bottom filter results.
default String	getParameterName()	The parameter whose value should be used for the filter value.
default String	getTimeGranularity()	The level of time precision that is used to aggregate DateTime values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregationSortConfigurations

@Stability(Stable)
@NotNull
Object getAggregationSortConfigurations()

The aggregation and sort configuration of the top bottom filter.

getColumn

@Stability(Stable)
@NotNull
Object getColumn()

The column that the filter is applied to.

getFilterId

@Stability(Stable)
@NotNull
String getFilterId()

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

getLimit

@Stability(Stable)
@Nullable
default Number getLimit()

The number of items to include in the top bottom filter results.

getParameterName

@Stability(Stable)
@Nullable
default String getParameterName()

The parameter whose value should be used for the filter value.

getTimeGranularity

@Stability(Stable)
@Nullable
default String getTimeGranularity()

The level of time precision that is used to aggregate DateTime values.

builder

@Stability(Stable)
static CfnDashboard.TopBottomFilterProperty.Builder builder()

Returns:

a CfnDashboard.TopBottomFilterProperty.Builder of CfnDashboard.TopBottomFilterProperty