Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.NumericEqualityFilterProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDashboard.NumericEqualityFilterProperty.Jsii$Proxy
Enclosing class:
CfnDashboard
@Stability(Stable) public static interface CfnDashboard.NumericEqualityFilterProperty extends software.amazon.jsii.JsiiSerializable
A NumericEqualityFilter filters values that are equal to the specified value.

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.*;
 NumericEqualityFilterProperty numericEqualityFilterProperty = NumericEqualityFilterProperty.builder()
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         .matchOperator("matchOperator")
         .nullOption("nullOption")
         // the properties below are optional
         .aggregationFunction(AggregationFunctionProperty.builder()
                 .categoricalAggregationFunction("categoricalAggregationFunction")
                 .dateAggregationFunction("dateAggregationFunction")
                 .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                         .percentileAggregation(PercentileAggregationProperty.builder()
                                 .percentileValue(123)
                                 .build())
                         .simpleNumericalAggregation("simpleNumericalAggregation")
                         .build())
                 .build())
         .parameterName("parameterName")
         .selectAllOptions("selectAllOptions")
         .value(123)
         .build();

  • Method Details

    • 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.

    • getMatchOperator

      @Stability(Stable) @NotNull String getMatchOperator()
      The match operator that is used to determine if a filter should be applied.

    • getNullOption

      @Stability(Stable) @NotNull String getNullOption()
      This option determines how null values should be treated when filtering data.

      • ALL_VALUES : Include null values in filtered results.
      • NULLS_ONLY : Only include null values in filtered results.
      • NON_NULLS_ONLY : Exclude null values from filtered results.

    • getAggregationFunction

      @Stability(Stable) @Nullable default Object getAggregationFunction()
      The aggregation function of the filter.

    • getParameterName

      @Stability(Stable) @Nullable default String getParameterName()
      The parameter whose value should be used for the filter value.

    • getSelectAllOptions

      @Stability(Stable) @Nullable default String getSelectAllOptions()
      Select all of the values. Null is not the assigned value of select all.

      • FILTER_ALL_VALUES

    • getValue

      @Stability(Stable) @Nullable default Number getValue()
      The input value.

    • builder

      @Stability(Stable) static CfnDashboard.NumericEqualityFilterProperty.Builder builder()
      Returns:
      a CfnDashboard.NumericEqualityFilterProperty.Builder of CfnDashboard.NumericEqualityFilterProperty