Class: AWSCDK::QuickSight::CfnAnalysis::NumericRangeFilterProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_analysis.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:



19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
 
# File 'quick_sight/cfn_analysis.rb', line 19497

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::CfnAnalysis::ColumnIdentifierProperty.new(**column.transform_keys(&:to_sym)) : column
  Jsii::Type.check_type(@column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNvbHVtbklkZW50aWZpZXJQcm9wZXJ0eSJ9XX19")), "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::CfnAnalysis::AggregationFunctionProperty.new(**aggregation_function.transform_keys(&:to_sym)) : aggregation_function
  Jsii::Type.check_type(@aggregation_function, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkFnZ3JlZ2F0aW9uRnVuY3Rpb25Qcm9wZXJ0eSJ9XX19")), "aggregationFunction") unless @aggregation_function.nil?
  @default_filter_control_configuration = default_filter_control_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkRlZmF1bHRGaWx0ZXJDb250cm9sQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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::CfnAnalysis::NumericRangeFilterValueProperty.new(**range_maximum.transform_keys(&:to_sym)) : range_maximum
  Jsii::Type.check_type(@range_maximum, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLk51bWVyaWNSYW5nZUZpbHRlclZhbHVlUHJvcGVydHkifV19fQ==")), "rangeMaximum") unless @range_maximum.nil?
  @range_minimum = range_minimum.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::NumericRangeFilterValueProperty.new(**range_minimum.transform_keys(&:to_sym)) : range_minimum
  Jsii::Type.check_type(@range_minimum, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLk51bWVyaWNSYW5nZUZpbHRlclZhbHVlUHJvcGVydHkifV19fQ==")), "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:



19543
19544
19545
 
# File 'quick_sight/cfn_analysis.rb', line 19543

def aggregation_function
  @aggregation_function
end

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

The column that the filter is applied to.

Returns:

See Also:



19524
19525
19526
 
# File 'quick_sight/cfn_analysis.rb', line 19524

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:



19550
19551
19552
 
# File 'quick_sight/cfn_analysis.rb', line 19550

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:



19529
19530
19531
 
# File 'quick_sight/cfn_analysis.rb', line 19529

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:



19555
19556
19557
 
# File 'quick_sight/cfn_analysis.rb', line 19555

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:



19560
19561
19562
 
# File 'quick_sight/cfn_analysis.rb', line 19560

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:



19538
19539
19540
 
# File 'quick_sight/cfn_analysis.rb', line 19538

def null_option
  @null_option
end

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

The maximum value for the filter value range.

Returns:

See Also:



19565
19566
19567
 
# File 'quick_sight/cfn_analysis.rb', line 19565

def range_maximum
  @range_maximum
end

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

The minimum value for the filter value range.

Returns:

See Also:



19570
19571
19572
 
# File 'quick_sight/cfn_analysis.rb', line 19570

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:



19577
19578
19579
 
# File 'quick_sight/cfn_analysis.rb', line 19577

def select_all_options
  @select_all_options
end

Class Method Details

.jsii_properties ⇒ Object 



19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
19589
19590
19591
19592
 
# File 'quick_sight/cfn_analysis.rb', line 19579

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 



19594
19595
19596
19597
19598
19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
 
# File 'quick_sight/cfn_analysis.rb', line 19594

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