Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.CustomFilterConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.CustomFilterConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.CustomFilterConfigurationProperty.Builder	builder()
default String	getCategoryValue()	The category value for the filter.
String	getMatchOperator()	The match operator that is used to determine if a filter should be applied.
String	getNullOption()	This option determines how null values should be treated when filtering data.
default String	getParameterName()	The parameter whose value should be used for the filter value.
default String	getSelectAllOptions()	Select all of the values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMatchOperator

@Stability(Stable)
@NotNull
String getMatchOperator()

The match operator that is used to determine if a filter should be applied.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-matchoperator

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-nulloption

getCategoryValue

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

The category value for the filter.

This field is mutually exclusive to ParameterName .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-categoryvalue

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-parametername

getSelectAllOptions

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

Select all of the values. Null is not the assigned value of select all.

• FILTER_ALL_VALUES

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-customfilterconfiguration.html#cfn-quicksight-dashboard-customfilterconfiguration-selectalloptions

builder

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

Returns:

a CfnDashboard.CustomFilterConfigurationProperty.Builder of CfnDashboard.CustomFilterConfigurationProperty