Class: AWSCDK::QuickSight::CfnDashboard::NumericRangeFilterProperty

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



20469
20470
20471
20472
20473
20474
20475
20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
 
# File 'quick_sight/cfn_dashboard.rb', line 20469

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



20515
20516
20517
 
# File 'quick_sight/cfn_dashboard.rb', line 20515

def aggregation_function
  @aggregation_function
end

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

The column that the filter is applied to.

Returns:

See Also:



20496
20497
20498
 
# File 'quick_sight/cfn_dashboard.rb', line 20496

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:



20522
20523
20524
 
# File 'quick_sight/cfn_dashboard.rb', line 20522

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:



20501
20502
20503
 
# File 'quick_sight/cfn_dashboard.rb', line 20501

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:



20527
20528
20529
 
# File 'quick_sight/cfn_dashboard.rb', line 20527

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:



20532
20533
20534
 
# File 'quick_sight/cfn_dashboard.rb', line 20532

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:



20510
20511
20512
 
# File 'quick_sight/cfn_dashboard.rb', line 20510

def null_option
  @null_option
end

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

The maximum value for the filter value range.

Returns:

See Also:



20537
20538
20539
 
# File 'quick_sight/cfn_dashboard.rb', line 20537

def range_maximum
  @range_maximum
end

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

The minimum value for the filter value range.

Returns:

See Also:



20542
20543
20544
 
# File 'quick_sight/cfn_dashboard.rb', line 20542

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:



20549
20550
20551
 
# File 'quick_sight/cfn_dashboard.rb', line 20549

def select_all_options
  @select_all_options
end

Class Method Details

.jsii_properties ⇒ Object 



20551
20552
20553
20554
20555
20556
20557
20558
20559
20560
20561
20562
20563
20564
 
# File 'quick_sight/cfn_dashboard.rb', line 20551

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 



20566
20567
20568
20569
20570
20571
20572
20573
20574
20575
20576
20577
20578
20579
20580
20581
 
# File 'quick_sight/cfn_dashboard.rb', line 20566

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