Class: AWSCDK::QuickSight::CfnDashboard::FilterProperty

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



11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
 
# File 'quick_sight/cfn_dashboard.rb', line 11185

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::CfnDashboard::CategoryFilterProperty.new(**category_filter.transform_keys(&:to_sym)) : category_filter
  Jsii::Type.check_type(@category_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5DYXRlZ29yeUZpbHRlclByb3BlcnR5In1dfX0=")), "categoryFilter") unless @category_filter.nil?
  @nested_filter = nested_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::NestedFilterProperty.new(**nested_filter.transform_keys(&:to_sym)) : nested_filter
  Jsii::Type.check_type(@nested_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5OZXN0ZWRGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "nestedFilter") unless @nested_filter.nil?
  @numeric_equality_filter = numeric_equality_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::NumericEqualityFilterProperty.new(**numeric_equality_filter.transform_keys(&:to_sym)) : numeric_equality_filter
  Jsii::Type.check_type(@numeric_equality_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5OdW1lcmljRXF1YWxpdHlGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "numericEqualityFilter") unless @numeric_equality_filter.nil?
  @numeric_range_filter = numeric_range_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::NumericRangeFilterProperty.new(**numeric_range_filter.transform_keys(&:to_sym)) : numeric_range_filter
  Jsii::Type.check_type(@numeric_range_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5OdW1lcmljUmFuZ2VGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "numericRangeFilter") unless @numeric_range_filter.nil?
  @relative_dates_filter = relative_dates_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::RelativeDatesFilterProperty.new(**relative_dates_filter.transform_keys(&:to_sym)) : relative_dates_filter
  Jsii::Type.check_type(@relative_dates_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5SZWxhdGl2ZURhdGVzRmlsdGVyUHJvcGVydHkifV19fQ==")), "relativeDatesFilter") unless @relative_dates_filter.nil?
  @time_equality_filter = time_equality_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::TimeEqualityFilterProperty.new(**time_equality_filter.transform_keys(&:to_sym)) : time_equality_filter
  Jsii::Type.check_type(@time_equality_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5UaW1lRXF1YWxpdHlGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "timeEqualityFilter") unless @time_equality_filter.nil?
  @time_range_filter = time_range_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::TimeRangeFilterProperty.new(**time_range_filter.transform_keys(&:to_sym)) : time_range_filter
  Jsii::Type.check_type(@time_range_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5UaW1lUmFuZ2VGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "timeRangeFilter") unless @time_range_filter.nil?
  @top_bottom_filter = top_bottom_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::TopBottomFilterProperty.new(**top_bottom_filter.transform_keys(&:to_sym)) : top_bottom_filter
  Jsii::Type.check_type(@top_bottom_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Ub3BCb3R0b21GaWx0ZXJQcm9wZXJ0eSJ9XX19")), "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:



11210
11211
11212
 
# File 'quick_sight/cfn_dashboard.rb', line 11210

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:



11215
11216
11217
 
# File 'quick_sight/cfn_dashboard.rb', line 11215

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:



11220
11221
11222
 
# File 'quick_sight/cfn_dashboard.rb', line 11220

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:



11225
11226
11227
 
# File 'quick_sight/cfn_dashboard.rb', line 11225

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:



11230
11231
11232
 
# File 'quick_sight/cfn_dashboard.rb', line 11230

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:



11235
11236
11237
 
# File 'quick_sight/cfn_dashboard.rb', line 11235

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:



11240
11241
11242
 
# File 'quick_sight/cfn_dashboard.rb', line 11240

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:



11245
11246
11247
 
# File 'quick_sight/cfn_dashboard.rb', line 11245

def top_bottom_filter
  @top_bottom_filter
end

Class Method Details

.jsii_properties ⇒ Object 



11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
 
# File 'quick_sight/cfn_dashboard.rb', line 11247

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 



11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
 
# File 'quick_sight/cfn_dashboard.rb', line 11260

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