Class: AWSCDK::QuickSight::CfnTemplate::NumericEqualityFilterProperty

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

Overview

A NumericEqualityFilter filters values that are equal to the specified value.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(column:, filter_id:, match_operator:, null_option:, aggregation_function: nil, default_filter_control_configuration: nil, parameter_name: nil, select_all_options: nil, value: nil) ⇒ NumericEqualityFilterProperty

Returns a new instance of NumericEqualityFilterProperty.

Parameters:



17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
 
# File 'quick_sight/cfn_template.rb', line 17509

def initialize(column:, filter_id:, match_operator:, null_option:, aggregation_function: nil, default_filter_control_configuration: nil, parameter_name: nil, select_all_options: nil, value: 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")
  @match_operator = match_operator
  Jsii::Type.check_type(@match_operator, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "matchOperator")
  @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?
  @parameter_name = parameter_name
  Jsii::Type.check_type(@parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterName") unless @parameter_name.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?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

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

The aggregation function of the filter.

Returns:

See Also:



17558
17559
17560
 
# File 'quick_sight/cfn_template.rb', line 17558

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:



17534
17535
17536
 
# File 'quick_sight/cfn_template.rb', line 17534

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:



17565
17566
17567
 
# File 'quick_sight/cfn_template.rb', line 17565

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:



17539
17540
17541
 
# File 'quick_sight/cfn_template.rb', line 17539

def filter_id
  @filter_id
end

#match_operator ⇒ String (readonly)

The match operator that is used to determine if a filter should be applied.

Returns:

  • (String)

See Also:



17544
17545
17546
 
# File 'quick_sight/cfn_template.rb', line 17544

def match_operator
  @match_operator
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:



17553
17554
17555
 
# File 'quick_sight/cfn_template.rb', line 17553

def null_option
  @null_option
end

#parameter_name ⇒ String? (readonly)

The parameter whose value should be used for the filter value.

Returns:

  • (String, nil)

See Also:



17570
17571
17572
 
# File 'quick_sight/cfn_template.rb', line 17570

def parameter_name
  @parameter_name
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:



17577
17578
17579
 
# File 'quick_sight/cfn_template.rb', line 17577

def select_all_options
  @select_all_options
end

#value ⇒ Numeric? (readonly)

The input value.

Returns:

  • (Numeric, nil)

See Also:



17582
17583
17584
 
# File 'quick_sight/cfn_template.rb', line 17582

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
 
# File 'quick_sight/cfn_template.rb', line 17584

def self.jsii_properties
  {
    :column => "column",
    :filter_id => "filterId",
    :match_operator => "matchOperator",
    :null_option => "nullOption",
    :aggregation_function => "aggregationFunction",
    :default_filter_control_configuration => "defaultFilterControlConfiguration",
    :parameter_name => "parameterName",
    :select_all_options => "selectAllOptions",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
 
# File 'quick_sight/cfn_template.rb', line 17598

def to_jsii
  result = {}
  result.merge!({
    "column" => @column,
    "filterId" => @filter_id,
    "matchOperator" => @match_operator,
    "nullOption" => @null_option,
    "aggregationFunction" => @aggregation_function,
    "defaultFilterControlConfiguration" => @default_filter_control_configuration,
    "parameterName" => @parameter_name,
    "selectAllOptions" => @select_all_options,
    "value" => @value,
  })
  result.compact
end