Class: AWSCDK::QuickSight::CfnTemplate::FilterProperty

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



10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
 
# File 'quick_sight/cfn_template.rb', line 10240

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::CfnTemplate::CategoryFilterProperty.new(**category_filter.transform_keys(&:to_sym)) : category_filter
  Jsii::Type.check_type(@category_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNhdGVnb3J5RmlsdGVyUHJvcGVydHkifV19fQ==")), "categoryFilter") unless @category_filter.nil?
  @nested_filter = nested_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::NestedFilterProperty.new(**nested_filter.transform_keys(&:to_sym)) : nested_filter
  Jsii::Type.check_type(@nested_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLk5lc3RlZEZpbHRlclByb3BlcnR5In1dfX0=")), "nestedFilter") unless @nested_filter.nil?
  @numeric_equality_filter = numeric_equality_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::NumericEqualityFilterProperty.new(**numeric_equality_filter.transform_keys(&:to_sym)) : numeric_equality_filter
  Jsii::Type.check_type(@numeric_equality_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLk51bWVyaWNFcXVhbGl0eUZpbHRlclByb3BlcnR5In1dfX0=")), "numericEqualityFilter") unless @numeric_equality_filter.nil?
  @numeric_range_filter = numeric_range_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::NumericRangeFilterProperty.new(**numeric_range_filter.transform_keys(&:to_sym)) : numeric_range_filter
  Jsii::Type.check_type(@numeric_range_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLk51bWVyaWNSYW5nZUZpbHRlclByb3BlcnR5In1dfX0=")), "numericRangeFilter") unless @numeric_range_filter.nil?
  @relative_dates_filter = relative_dates_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::RelativeDatesFilterProperty.new(**relative_dates_filter.transform_keys(&:to_sym)) : relative_dates_filter
  Jsii::Type.check_type(@relative_dates_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlJlbGF0aXZlRGF0ZXNGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "relativeDatesFilter") unless @relative_dates_filter.nil?
  @time_equality_filter = time_equality_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TimeEqualityFilterProperty.new(**time_equality_filter.transform_keys(&:to_sym)) : time_equality_filter
  Jsii::Type.check_type(@time_equality_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRpbWVFcXVhbGl0eUZpbHRlclByb3BlcnR5In1dfX0=")), "timeEqualityFilter") unless @time_equality_filter.nil?
  @time_range_filter = time_range_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TimeRangeFilterProperty.new(**time_range_filter.transform_keys(&:to_sym)) : time_range_filter
  Jsii::Type.check_type(@time_range_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRpbWVSYW5nZUZpbHRlclByb3BlcnR5In1dfX0=")), "timeRangeFilter") unless @time_range_filter.nil?
  @top_bottom_filter = top_bottom_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TopBottomFilterProperty.new(**top_bottom_filter.transform_keys(&:to_sym)) : top_bottom_filter
  Jsii::Type.check_type(@top_bottom_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRvcEJvdHRvbUZpbHRlclByb3BlcnR5In1dfX0=")), "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:



10265
10266
10267
 
# File 'quick_sight/cfn_template.rb', line 10265

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:



10270
10271
10272
 
# File 'quick_sight/cfn_template.rb', line 10270

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:



10275
10276
10277
 
# File 'quick_sight/cfn_template.rb', line 10275

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:



10280
10281
10282
 
# File 'quick_sight/cfn_template.rb', line 10280

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:



10285
10286
10287
 
# File 'quick_sight/cfn_template.rb', line 10285

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:



10290
10291
10292
 
# File 'quick_sight/cfn_template.rb', line 10290

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:



10295
10296
10297
 
# File 'quick_sight/cfn_template.rb', line 10295

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:



10300
10301
10302
 
# File 'quick_sight/cfn_template.rb', line 10300

def top_bottom_filter
  @top_bottom_filter
end

Class Method Details

.jsii_properties ⇒ Object 



10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
 
# File 'quick_sight/cfn_template.rb', line 10302

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 



10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
 
# File 'quick_sight/cfn_template.rb', line 10315

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