Class: AWSCDK::QuickSight::CfnAnalysis::FilterProperty

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

Overview

With a Filter , you can remove portions of data from a particular visual or view.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(category_filter: nil, nested_filter: nil, numeric_equality_filter: nil, numeric_range_filter: nil, relative_dates_filter: nil, time_equality_filter: nil, time_range_filter: nil, top_bottom_filter: nil) ⇒ FilterProperty

Returns a new instance of FilterProperty.

Parameters:



10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
 
# File 'quick_sight/cfn_analysis.rb', line 10432

def initialize(category_filter: nil, nested_filter: nil, numeric_equality_filter: nil, numeric_range_filter: nil, relative_dates_filter: nil, time_equality_filter: nil, time_range_filter: nil, top_bottom_filter: nil)
  @category_filter = category_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::CategoryFilterProperty.new(**category_filter.transform_keys(&:to_sym)) : category_filter
  Jsii::Type.check_type(@category_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNhdGVnb3J5RmlsdGVyUHJvcGVydHkifV19fQ==")), "categoryFilter") unless @category_filter.nil?
  @nested_filter = nested_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::NestedFilterProperty.new(**nested_filter.transform_keys(&:to_sym)) : nested_filter
  Jsii::Type.check_type(@nested_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLk5lc3RlZEZpbHRlclByb3BlcnR5In1dfX0=")), "nestedFilter") unless @nested_filter.nil?
  @numeric_equality_filter = numeric_equality_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::NumericEqualityFilterProperty.new(**numeric_equality_filter.transform_keys(&:to_sym)) : numeric_equality_filter
  Jsii::Type.check_type(@numeric_equality_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLk51bWVyaWNFcXVhbGl0eUZpbHRlclByb3BlcnR5In1dfX0=")), "numericEqualityFilter") unless @numeric_equality_filter.nil?
  @numeric_range_filter = numeric_range_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::NumericRangeFilterProperty.new(**numeric_range_filter.transform_keys(&:to_sym)) : numeric_range_filter
  Jsii::Type.check_type(@numeric_range_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLk51bWVyaWNSYW5nZUZpbHRlclByb3BlcnR5In1dfX0=")), "numericRangeFilter") unless @numeric_range_filter.nil?
  @relative_dates_filter = relative_dates_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::RelativeDatesFilterProperty.new(**relative_dates_filter.transform_keys(&:to_sym)) : relative_dates_filter
  Jsii::Type.check_type(@relative_dates_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlJlbGF0aXZlRGF0ZXNGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "relativeDatesFilter") unless @relative_dates_filter.nil?
  @time_equality_filter = time_equality_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TimeEqualityFilterProperty.new(**time_equality_filter.transform_keys(&:to_sym)) : time_equality_filter
  Jsii::Type.check_type(@time_equality_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRpbWVFcXVhbGl0eUZpbHRlclByb3BlcnR5In1dfX0=")), "timeEqualityFilter") unless @time_equality_filter.nil?
  @time_range_filter = time_range_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TimeRangeFilterProperty.new(**time_range_filter.transform_keys(&:to_sym)) : time_range_filter
  Jsii::Type.check_type(@time_range_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRpbWVSYW5nZUZpbHRlclByb3BlcnR5In1dfX0=")), "timeRangeFilter") unless @time_range_filter.nil?
  @top_bottom_filter = top_bottom_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TopBottomFilterProperty.new(**top_bottom_filter.transform_keys(&:to_sym)) : top_bottom_filter
  Jsii::Type.check_type(@top_bottom_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRvcEJvdHRvbUZpbHRlclByb3BlcnR5In1dfX0=")), "topBottomFilter") unless @top_bottom_filter.nil?
end

Instance Attribute Details

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

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon Quick Suite User Guide .

Returns:

See Also:



10457
10458
10459
 
# File 'quick_sight/cfn_analysis.rb', line 10457

def category_filter
  @category_filter
end

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

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

Returns:

See Also:



10462
10463
10464
 
# File 'quick_sight/cfn_analysis.rb', line 10462

def nested_filter
  @nested_filter
end

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

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

Returns:

See Also:



10467
10468
10469
 
# File 'quick_sight/cfn_analysis.rb', line 10467

def numeric_equality_filter
  @numeric_equality_filter
end

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

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

Returns:

See Also:



10472
10473
10474
 
# File 'quick_sight/cfn_analysis.rb', line 10472

def numeric_range_filter
  @numeric_range_filter
end

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

A RelativeDatesFilter filters date values that are relative to a given date.

Returns:

See Also:



10477
10478
10479
 
# File 'quick_sight/cfn_analysis.rb', line 10477

def relative_dates_filter
  @relative_dates_filter
end

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

A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.

Returns:

See Also:



10482
10483
10484
 
# File 'quick_sight/cfn_analysis.rb', line 10482

def time_equality_filter
  @time_equality_filter
end

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

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

Returns:

See Also:



10487
10488
10489
 
# File 'quick_sight/cfn_analysis.rb', line 10487

def time_range_filter
  @time_range_filter
end

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

A TopBottomFilter filters data to the top or bottom values for a given column.

Returns:

See Also:



10492
10493
10494
 
# File 'quick_sight/cfn_analysis.rb', line 10492

def top_bottom_filter
  @top_bottom_filter
end

Class Method Details

.jsii_properties ⇒ Object 



10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
 
# File 'quick_sight/cfn_analysis.rb', line 10494

def self.jsii_properties
  {
    :category_filter => "categoryFilter",
    :nested_filter => "nestedFilter",
    :numeric_equality_filter => "numericEqualityFilter",
    :numeric_range_filter => "numericRangeFilter",
    :relative_dates_filter => "relativeDatesFilter",
    :time_equality_filter => "timeEqualityFilter",
    :time_range_filter => "timeRangeFilter",
    :top_bottom_filter => "topBottomFilter",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
 
# File 'quick_sight/cfn_analysis.rb', line 10507

def to_jsii
  result = {}
  result.merge!({
    "categoryFilter" => @category_filter,
    "nestedFilter" => @nested_filter,
    "numericEqualityFilter" => @numeric_equality_filter,
    "numericRangeFilter" => @numeric_range_filter,
    "relativeDatesFilter" => @relative_dates_filter,
    "timeEqualityFilter" => @time_equality_filter,
    "timeRangeFilter" => @time_range_filter,
    "topBottomFilter" => @top_bottom_filter,
  })
  result.compact
end