Package software.amazon.awscdk.services.quicksight

Interface CfnTopic.TopicNumericRangeFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopic.TopicNumericRangeFilterProperty.Jsii$Proxy

Enclosing class:

CfnTopic

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

A filter that filters topics based on the value of a numeric field.

The filter includes only topics whose numeric field value falls within the specified range.

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.*;
 TopicNumericRangeFilterProperty topicNumericRangeFilterProperty = TopicNumericRangeFilterProperty.builder()
         .aggregation("aggregation")
         .constant(TopicRangeFilterConstantProperty.builder()
                 .constantType("constantType")
                 .rangeConstant(RangeConstantProperty.builder()
                         .maximum("maximum")
                         .minimum("minimum")
                         .build())
                 .build())
         .inclusive(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopic.TopicNumericRangeFilterProperty.Builder	builder()
default String	getAggregation()	An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .
default Object	getConstant()	The constant used in a numeric range filter.
default Object	getInclusive()	A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregation

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

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION , SUM , AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR , and VARP .

See Also:

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

getConstant

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

The constant used in a numeric range filter.

See Also:

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

getInclusive

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

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.

If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

Default: - false

See Also:

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

builder

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

Returns:

a CfnTopic.TopicNumericRangeFilterProperty.Builder of CfnTopic.TopicNumericRangeFilterProperty