Class: AWSCDK::QuickSight::CfnDashboard::NumericEqualityFilterProperty

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



20292
20293
20294
20295
20296
20297
20298
20299
20300
20301
20302
20303
20304
20305
20306
20307
20308
20309
20310
20311
 
# File 'quick_sight/cfn_dashboard.rb', line 20292

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::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")
  @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::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?
  @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:



20341
20342
20343
 
# File 'quick_sight/cfn_dashboard.rb', line 20341

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:



20317
20318
20319
 
# File 'quick_sight/cfn_dashboard.rb', line 20317

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:



20348
20349
20350
 
# File 'quick_sight/cfn_dashboard.rb', line 20348

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:



20322
20323
20324
 
# File 'quick_sight/cfn_dashboard.rb', line 20322

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:



20327
20328
20329
 
# File 'quick_sight/cfn_dashboard.rb', line 20327

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:



20336
20337
20338
 
# File 'quick_sight/cfn_dashboard.rb', line 20336

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:



20353
20354
20355
 
# File 'quick_sight/cfn_dashboard.rb', line 20353

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:



20360
20361
20362
 
# File 'quick_sight/cfn_dashboard.rb', line 20360

def select_all_options
  @select_all_options
end

#value ⇒ Numeric? (readonly)

The input value.

Returns:

  • (Numeric, nil)

See Also:



20365
20366
20367
 
# File 'quick_sight/cfn_dashboard.rb', line 20365

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
 
# File 'quick_sight/cfn_dashboard.rb', line 20367

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 



20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
20393
20394
20395
 
# File 'quick_sight/cfn_dashboard.rb', line 20381

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