Class: AWSCDK::QuickSight::CfnTemplate::NumericRangeFilterProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_template.rb

Overview

A NumericRangeFilter filters values that are within the value range.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(column:, filter_id:, null_option:, aggregation_function: nil, default_filter_control_configuration: nil, include_maximum: nil, include_minimum: nil, range_maximum: nil, range_minimum: nil, select_all_options: nil) ⇒ NumericRangeFilterProperty

Returns a new instance of NumericRangeFilterProperty.

Parameters:



17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
 
# File 'quick_sight/cfn_template.rb', line 17686

def initialize(column:, filter_id:, null_option:, aggregation_function: nil, default_filter_control_configuration: nil, include_maximum: nil, include_minimum: nil, range_maximum: nil, range_minimum: nil, select_all_options: nil)
  @column = column.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty.new(**column.transform_keys(&:to_sym)) : column
  Jsii::Type.check_type(@column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNvbHVtbklkZW50aWZpZXJQcm9wZXJ0eSJ9XX19")), "column")
  @filter_id = filter_id
  Jsii::Type.check_type(@filter_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterId")
  @null_option = null_option
  Jsii::Type.check_type(@null_option, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nullOption")
  @aggregation_function = aggregation_function.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::AggregationFunctionProperty.new(**aggregation_function.transform_keys(&:to_sym)) : aggregation_function
  Jsii::Type.check_type(@aggregation_function, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkFnZ3JlZ2F0aW9uRnVuY3Rpb25Qcm9wZXJ0eSJ9XX19")), "aggregationFunction") unless @aggregation_function.nil?
  @default_filter_control_configuration = default_filter_control_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DefaultFilterControlConfigurationProperty.new(**default_filter_control_configuration.transform_keys(&:to_sym)) : default_filter_control_configuration
  Jsii::Type.check_type(@default_filter_control_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRlZmF1bHRGaWx0ZXJDb250cm9sQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "defaultFilterControlConfiguration") unless @default_filter_control_configuration.nil?
  @include_maximum = include_maximum
  Jsii::Type.check_type(@include_maximum, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "includeMaximum") unless @include_maximum.nil?
  @include_minimum = include_minimum
  Jsii::Type.check_type(@include_minimum, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "includeMinimum") unless @include_minimum.nil?
  @range_maximum = range_maximum.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::NumericRangeFilterValueProperty.new(**range_maximum.transform_keys(&:to_sym)) : range_maximum
  Jsii::Type.check_type(@range_maximum, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLk51bWVyaWNSYW5nZUZpbHRlclZhbHVlUHJvcGVydHkifV19fQ==")), "rangeMaximum") unless @range_maximum.nil?
  @range_minimum = range_minimum.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::NumericRangeFilterValueProperty.new(**range_minimum.transform_keys(&:to_sym)) : range_minimum
  Jsii::Type.check_type(@range_minimum, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLk51bWVyaWNSYW5nZUZpbHRlclZhbHVlUHJvcGVydHkifV19fQ==")), "rangeMinimum") unless @range_minimum.nil?
  @select_all_options = select_all_options
  Jsii::Type.check_type(@select_all_options, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "selectAllOptions") unless @select_all_options.nil?
end

Instance Attribute Details

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

The aggregation function of the filter.

Returns:

See Also:



17732
17733
17734
 
# File 'quick_sight/cfn_template.rb', line 17732

def aggregation_function
  @aggregation_function
end

#column ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::ColumnIdentifierProperty (readonly)

The column that the filter is applied to.

Returns:

See Also:



17713
17714
17715
 
# File 'quick_sight/cfn_template.rb', line 17713

def column
  @column
end

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

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

Returns:

See Also:



17739
17740
17741
 
# File 'quick_sight/cfn_template.rb', line 17739

def default_filter_control_configuration
  @default_filter_control_configuration
end

#filter_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



17718
17719
17720
 
# File 'quick_sight/cfn_template.rb', line 17718

def filter_id
  @filter_id
end

#include_maximum ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



17744
17745
17746
 
# File 'quick_sight/cfn_template.rb', line 17744

def include_maximum
  @include_maximum
end

#include_minimum ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



17749
17750
17751
 
# File 'quick_sight/cfn_template.rb', line 17749

def include_minimum
  @include_minimum
end

#null_option ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



17727
17728
17729
 
# File 'quick_sight/cfn_template.rb', line 17727

def null_option
  @null_option
end

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

The maximum value for the filter value range.

Returns:

See Also:



17754
17755
17756
 
# File 'quick_sight/cfn_template.rb', line 17754

def range_maximum
  @range_maximum
end

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

The minimum value for the filter value range.

Returns:

See Also:



17759
17760
17761
 
# File 'quick_sight/cfn_template.rb', line 17759

def range_minimum
  @range_minimum
end

#select_all_options ⇒ String? (readonly)

Select all of the values. Null is not the assigned value of select all.

  • FILTER_ALL_VALUES

Returns:

  • (String, nil)

See Also:



17766
17767
17768
 
# File 'quick_sight/cfn_template.rb', line 17766

def select_all_options
  @select_all_options
end

Class Method Details

.jsii_properties ⇒ Object 



17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
 
# File 'quick_sight/cfn_template.rb', line 17768

def self.jsii_properties
  {
    :column => "column",
    :filter_id => "filterId",
    :null_option => "nullOption",
    :aggregation_function => "aggregationFunction",
    :default_filter_control_configuration => "defaultFilterControlConfiguration",
    :include_maximum => "includeMaximum",
    :include_minimum => "includeMinimum",
    :range_maximum => "rangeMaximum",
    :range_minimum => "rangeMinimum",
    :select_all_options => "selectAllOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
 
# File 'quick_sight/cfn_template.rb', line 17783

def to_jsii
  result = {}
  result.merge!({
    "column" => @column,
    "filterId" => @filter_id,
    "nullOption" => @null_option,
    "aggregationFunction" => @aggregation_function,
    "defaultFilterControlConfiguration" => @default_filter_control_configuration,
    "includeMaximum" => @include_maximum,
    "includeMinimum" => @include_minimum,
    "rangeMaximum" => @range_maximum,
    "rangeMinimum" => @range_minimum,
    "selectAllOptions" => @select_all_options,
  })
  result.compact
end