Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.NumericRangeFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.NumericRangeFilterProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.NumericRangeFilterProperty
extends software.amazon.jsii.JsiiSerializable

A NumericRangeFilter filters values that are within the value 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.*;
 NumericRangeFilterProperty numericRangeFilterProperty = NumericRangeFilterProperty.builder()
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         .nullOption("nullOption")
         // the properties below are optional
         .aggregationFunction(AggregationFunctionProperty.builder()
                 .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                         .simpleAttributeAggregation("simpleAttributeAggregation")
                         .valueForMultipleValues("valueForMultipleValues")
                         .build())
                 .categoricalAggregationFunction("categoricalAggregationFunction")
                 .dateAggregationFunction("dateAggregationFunction")
                 .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                         .percentileAggregation(PercentileAggregationProperty.builder()
                                 .percentileValue(123)
                                 .build())
                         .simpleNumericalAggregation("simpleNumericalAggregation")
                         .build())
                 .build())
         .includeMaximum(false)
         .includeMinimum(false)
         .rangeMaximum(NumericRangeFilterValueProperty.builder()
                 .parameter("parameter")
                 .staticValue(123)
                 .build())
         .rangeMinimum(NumericRangeFilterValueProperty.builder()
                 .parameter("parameter")
                 .staticValue(123)
                 .build())
         .selectAllOptions("selectAllOptions")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.NumericRangeFilterProperty.Builder	builder()
default Object	getAggregationFunction()	The aggregation function of the filter.
Object	getColumn()	The column that the filter is applied to.
String	getFilterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
default Object	getIncludeMaximum()	Determines whether the maximum value in the filter value range should be included in the filtered results.
default Object	getIncludeMinimum()	Determines whether the minimum value in the filter value range should be included in the filtered results.
String	getNullOption()	This option determines how null values should be treated when filtering data.
default Object	getRangeMaximum()	The maximum value for the filter value range.
default Object	getRangeMinimum()	The minimum value for the filter value range.
default String	getSelectAllOptions()	Select all of the values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumn

@Stability(Stable)
@NotNull
Object getColumn()

The column that the filter is applied to.

See Also:

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

getFilterId

@Stability(Stable)
@NotNull
String getFilterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

See Also:

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

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-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-nulloption

getAggregationFunction

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

The aggregation function of the filter.

See Also:

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

getIncludeMaximum

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

Determines whether the maximum value in the filter value range should be included in the filtered results.

See Also:

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

getIncludeMinimum

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

Determines whether the minimum value in the filter value range should be included in the filtered results.

See Also:

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

getRangeMaximum

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

The maximum value for the filter value range.

See Also:

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

getRangeMinimum

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

The minimum value for the filter value range.

See Also:

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

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-template-numericrangefilter.html#cfn-quicksight-template-numericrangefilter-selectalloptions

builder

@Stability(Stable)
static CfnTemplate.NumericRangeFilterProperty.Builder builder()

Returns:

a CfnTemplate.NumericRangeFilterProperty.Builder of CfnTemplate.NumericRangeFilterProperty