Interface CfnAnalysis.CustomFilterConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnAnalysis.CustomFilterConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnAnalysis

@Stability(Stable) public static interface CfnAnalysis.CustomFilterConfigurationProperty extends software.amazon.jsii.JsiiSerializable
A custom filter that filters based on a single value.

This filter can be partially matched.

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.*;
 CustomFilterConfigurationProperty customFilterConfigurationProperty = CustomFilterConfigurationProperty.builder()
         .matchOperator("matchOperator")
         .nullOption("nullOption")
         // the properties below are optional
         .categoryValue("categoryValue")
         .parameterName("parameterName")
         .selectAllOptions("selectAllOptions")
         .build();
 
  • Method Details

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

      @Stability(Stable) @Nullable default String getCategoryValue()
      The category value for the filter.

      This field is mutually exclusive to ParameterName .

    • getParameterName

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

      This field is mutually exclusive to CategoryValue .

    • getSelectAllOptions

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

      • FILTER_ALL_VALUES
    • builder

      @Stability(Stable) static CfnAnalysis.CustomFilterConfigurationProperty.Builder builder()
      Returns:
      a CfnAnalysis.CustomFilterConfigurationProperty.Builder of CfnAnalysis.CustomFilterConfigurationProperty