Package software.amazon.awscdk.services.quicksight

Interface CfnTopic.TopicFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopic.TopicFilterProperty.Jsii$Proxy

Enclosing class:

CfnTopic

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

A structure that represents a filter used to select items for a topic.

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.*;
 TopicFilterProperty topicFilterProperty = TopicFilterProperty.builder()
         .filterName("filterName")
         .operandFieldName("operandFieldName")
         // the properties below are optional
         .categoryFilter(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())
         .dateRangeFilter(TopicDateRangeFilterProperty.builder()
                 .constant(TopicRangeFilterConstantProperty.builder()
                         .constantType("constantType")
                         .rangeConstant(RangeConstantProperty.builder()
                                 .maximum("maximum")
                                 .minimum("minimum")
                                 .build())
                         .build())
                 .inclusive(false)
                 .build())
         .filterClass("filterClass")
         .filterDescription("filterDescription")
         .filterSynonyms(List.of("filterSynonyms"))
         .filterType("filterType")
         .numericEqualityFilter(TopicNumericEqualityFilterProperty.builder()
                 .aggregation("aggregation")
                 .constant(TopicSingularFilterConstantProperty.builder()
                         .constantType("constantType")
                         .singularConstant("singularConstant")
                         .build())
                 .build())
         .numericRangeFilter(TopicNumericRangeFilterProperty.builder()
                 .aggregation("aggregation")
                 .constant(TopicRangeFilterConstantProperty.builder()
                         .constantType("constantType")
                         .rangeConstant(RangeConstantProperty.builder()
                                 .maximum("maximum")
                                 .minimum("minimum")
                                 .build())
                         .build())
                 .inclusive(false)
                 .build())
         .relativeDateFilter(TopicRelativeDateFilterProperty.builder()
                 .constant(TopicSingularFilterConstantProperty.builder()
                         .constantType("constantType")
                         .singularConstant("singularConstant")
                         .build())
                 .relativeDateFilterFunction("relativeDateFilterFunction")
                 .timeGranularity("timeGranularity")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopic.TopicFilterProperty.Builder	builder()
default Object	getCategoryFilter()	The category filter that is associated with this filter.
default Object	getDateRangeFilter()	The date range filter.
default String	getFilterClass()	The class of the filter.
default String	getFilterDescription()	A description of the filter used to select items for a topic.
String	getFilterName()	The name of the filter.
default List<String>	getFilterSynonyms()	The other names or aliases for the filter.
default String	getFilterType()	The type of the filter.
default Object	getNumericEqualityFilter()	The numeric equality filter.
default Object	getNumericRangeFilter()	The numeric range filter.
String	getOperandFieldName()	The name of the field that the filter operates on.
default Object	getRelativeDateFilter()	The relative date filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFilterName

@Stability(Stable)
@NotNull
String getFilterName()

The name of the filter.

See Also:

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

getOperandFieldName

@Stability(Stable)
@NotNull
String getOperandFieldName()

The name of the field that the filter operates on.

See Also:

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

getCategoryFilter

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

The category filter that is associated with this filter.

See Also:

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

getDateRangeFilter

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

The date range filter.

See Also:

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

getFilterClass

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

The class of the filter.

Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .

See Also:

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

getFilterDescription

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

A description of the filter used to select items for a topic.

See Also:

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

getFilterSynonyms

@Stability(Stable)
@Nullable
default List<String> getFilterSynonyms()

The other names or aliases for the filter.

See Also:

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

getFilterType

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

The type of the filter.

Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .

See Also:

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

getNumericEqualityFilter

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

The numeric equality filter.

See Also:

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

getNumericRangeFilter

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

The numeric range filter.

See Also:

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

getRelativeDateFilter

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

The relative date filter.

See Also:

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

builder

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

Returns:

a CfnTopic.TopicFilterProperty.Builder of CfnTopic.TopicFilterProperty