Package software.amazon.awscdk.services.quicksight

Interface CfnTopic.TopicCategoryFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopic.TopicCategoryFilterProperty.Jsii$Proxy

Enclosing class:

CfnTopic

@Stability(Stable)
public static interface CfnTopic.TopicCategoryFilterProperty
extends software.amazon.jsii.JsiiSerializable

A structure that represents a category filter.

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.*;
 TopicCategoryFilterProperty topicCategoryFilterProperty = TopicCategoryFilterProperty.builder()
         .categoryFilterFunction("categoryFilterFunction")
         .categoryFilterType("categoryFilterType")
         .constant(TopicCategoryFilterConstantProperty.builder()
                 .collectiveConstant(CollectiveConstantProperty.builder()
                         .valueList(List.of("valueList"))
                         .build())
                 .constantType("constantType")
                 .singularConstant("singularConstant")
                 .build())
         .inverse(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopic.TopicCategoryFilterProperty.Builder	builder()
default String	getCategoryFilterFunction()	The category filter function.
default String	getCategoryFilterType()	The category filter type.
default Object	getConstant()	The constant used in a category filter.
default Object	getInverse()	A Boolean value that indicates if the filter is inverse.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCategoryFilterFunction

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

The category filter function.

Valid values for this structure are EXACT and CONTAINS .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-categoryfilterfunction

getCategoryFilterType

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

The category filter type.

This element is used to specify whether a filter is a simple category filter or an inverse category filter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-categoryfiltertype

getConstant

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

The constant used in a category filter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-constant

getInverse

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

A Boolean value that indicates if the filter is inverse.

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccategoryfilter.html#cfn-quicksight-topic-topiccategoryfilter-inverse

builder

@Stability(Stable)
static CfnTopic.TopicCategoryFilterProperty.Builder builder()

Returns:

a CfnTopic.TopicCategoryFilterProperty.Builder of CfnTopic.TopicCategoryFilterProperty