Class: AWSCDK::QuickSight::CfnTopic::TopicNumericRangeFilterProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTopic::TopicNumericRangeFilterProperty

Defined in:

quick_sight/cfn_topic.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #aggregation ⇒ String^? readonly

  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 .

• #constant ⇒ AWSCDK::IResolvable, ... readonly

  The constant used in a numeric range filter.

• #inclusive ⇒ Boolean, ... readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(aggregation: nil, constant: nil, inclusive: nil) ⇒ TopicNumericRangeFilterProperty constructor

  A new instance of TopicNumericRangeFilterProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(aggregation: nil, constant: nil, inclusive: nil) ⇒ TopicNumericRangeFilterProperty

Returns a new instance of TopicNumericRangeFilterProperty.

Parameters:

• aggregation (String, nil) (defaults to: nil) —

  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 .

• constant (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::TopicRangeFilterConstantProperty, nil) (defaults to: nil) —

  The constant used in a numeric range filter.

• inclusive (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

# File 'quick_sight/cfn_topic.rb', line 2358

def initialize(aggregation: nil, constant: nil, inclusive: nil)
  @aggregation = aggregation
  Jsii::Type.check_type(@aggregation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aggregation") unless @aggregation.nil?
  @constant = constant.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicRangeFilterConstantProperty.new(**constant.transform_keys(&:to_sym)) : constant
  Jsii::Type.check_type(@constant, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljUmFuZ2VGaWx0ZXJDb25zdGFudFByb3BlcnR5In1dfX0=")), "constant") unless @constant.nil?
  @inclusive = inclusive
  Jsii::Type.check_type(@inclusive, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "inclusive") unless @inclusive.nil?
end

Instance Attribute Details

#aggregation ⇒ String^? (readonly)

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 .

Returns:

• (String, nil)

See Also:

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

# File 'quick_sight/cfn_topic.rb', line 2371

def aggregation
  @aggregation
end

#constant ⇒ AWSCDK::IResolvable, ... (readonly)

The constant used in a numeric range filter.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::TopicRangeFilterConstantProperty, nil)

See Also:

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

# File 'quick_sight/cfn_topic.rb', line 2376

def constant
  @constant
end

#inclusive ⇒ Boolean, ... (readonly)

Note:

Default: - false

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.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

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

# File 'quick_sight/cfn_topic.rb', line 2384

def inclusive
  @inclusive
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 2386

def self.jsii_properties
  {
    :aggregation => "aggregation",
    :constant => "constant",
    :inclusive => "inclusive",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 2394

def to_jsii
  result = {}
  result.merge!({
    "aggregation" => @aggregation,
    "constant" => @constant,
    "inclusive" => @inclusive,
  })
  result.compact
end