Class: AWSCDK::QuickSight::CfnTopic::TopicFilterProperty

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

Overview

A structure that represents a filter used to select items for a topic.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filter_name:, operand_field_name:, category_filter: nil, date_range_filter: nil, filter_class: nil, filter_description: nil, filter_synonyms: nil, filter_type: nil, numeric_equality_filter: nil, numeric_range_filter: nil, relative_date_filter: nil) ⇒ TopicFilterProperty

Returns a new instance of TopicFilterProperty.

Parameters:



2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
 
# File 'quick_sight/cfn_topic.rb', line 2107

def initialize(filter_name:, operand_field_name:, category_filter: nil, date_range_filter: nil, filter_class: nil, filter_description: nil, filter_synonyms: nil, filter_type: nil, numeric_equality_filter: nil, numeric_range_filter: nil, relative_date_filter: nil)
  @filter_name = filter_name
  Jsii::Type.check_type(@filter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterName")
  @operand_field_name = operand_field_name
  Jsii::Type.check_type(@operand_field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operandFieldName")
  @category_filter = category_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicCategoryFilterProperty.new(**category_filter.transform_keys(&:to_sym)) : category_filter
  Jsii::Type.check_type(@category_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljQ2F0ZWdvcnlGaWx0ZXJQcm9wZXJ0eSJ9XX19")), "categoryFilter") unless @category_filter.nil?
  @date_range_filter = date_range_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicDateRangeFilterProperty.new(**date_range_filter.transform_keys(&:to_sym)) : date_range_filter
  Jsii::Type.check_type(@date_range_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljRGF0ZVJhbmdlRmlsdGVyUHJvcGVydHkifV19fQ==")), "dateRangeFilter") unless @date_range_filter.nil?
  @filter_class = filter_class
  Jsii::Type.check_type(@filter_class, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterClass") unless @filter_class.nil?
  @filter_description = filter_description
  Jsii::Type.check_type(@filter_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterDescription") unless @filter_description.nil?
  @filter_synonyms = filter_synonyms
  Jsii::Type.check_type(@filter_synonyms, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "filterSynonyms") unless @filter_synonyms.nil?
  @filter_type = filter_type
  Jsii::Type.check_type(@filter_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterType") unless @filter_type.nil?
  @numeric_equality_filter = numeric_equality_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicNumericEqualityFilterProperty.new(**numeric_equality_filter.transform_keys(&:to_sym)) : numeric_equality_filter
  Jsii::Type.check_type(@numeric_equality_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljTnVtZXJpY0VxdWFsaXR5RmlsdGVyUHJvcGVydHkifV19fQ==")), "numericEqualityFilter") unless @numeric_equality_filter.nil?
  @numeric_range_filter = numeric_range_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicNumericRangeFilterProperty.new(**numeric_range_filter.transform_keys(&:to_sym)) : numeric_range_filter
  Jsii::Type.check_type(@numeric_range_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljTnVtZXJpY1JhbmdlRmlsdGVyUHJvcGVydHkifV19fQ==")), "numericRangeFilter") unless @numeric_range_filter.nil?
  @relative_date_filter = relative_date_filter.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicRelativeDateFilterProperty.new(**relative_date_filter.transform_keys(&:to_sym)) : relative_date_filter
  Jsii::Type.check_type(@relative_date_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljUmVsYXRpdmVEYXRlRmlsdGVyUHJvcGVydHkifV19fQ==")), "relativeDateFilter") unless @relative_date_filter.nil?
end

Instance Attribute Details

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

The category filter that is associated with this filter.

Returns:

See Also:



2146
2147
2148
 
# File 'quick_sight/cfn_topic.rb', line 2146

def category_filter
  @category_filter
end

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

The date range filter.

Returns:

See Also:



2151
2152
2153
 
# File 'quick_sight/cfn_topic.rb', line 2151

def date_range_filter
  @date_range_filter
end

#filter_class ⇒ String? (readonly)

The class of the filter.

Valid values for this structure are ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .

Returns:

  • (String, nil)

See Also:



2158
2159
2160
 
# File 'quick_sight/cfn_topic.rb', line 2158

def filter_class
  @filter_class
end

#filter_description ⇒ String? (readonly)

A description of the filter used to select items for a topic.

Returns:

  • (String, nil)

See Also:



2163
2164
2165
 
# File 'quick_sight/cfn_topic.rb', line 2163

def filter_description
  @filter_description
end

#filter_name ⇒ String (readonly)

The name of the filter.

Returns:

  • (String)

See Also:



2136
2137
2138
 
# File 'quick_sight/cfn_topic.rb', line 2136

def filter_name
  @filter_name
end

#filter_synonyms ⇒ Array<String>? (readonly)

The other names or aliases for the filter.

Returns:

  • (Array<String>, nil)

See Also:



2168
2169
2170
 
# File 'quick_sight/cfn_topic.rb', line 2168

def filter_synonyms
  @filter_synonyms
end

#filter_type ⇒ String? (readonly)

The type of the filter.

Valid values for this structure are CATEGORY_FILTER , NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and RELATIVE_DATE_FILTER .

Returns:

  • (String, nil)

See Also:



2175
2176
2177
 
# File 'quick_sight/cfn_topic.rb', line 2175

def filter_type
  @filter_type
end

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

The numeric equality filter.

Returns:

See Also:



2180
2181
2182
 
# File 'quick_sight/cfn_topic.rb', line 2180

def numeric_equality_filter
  @numeric_equality_filter
end

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

The numeric range filter.

Returns:

See Also:



2185
2186
2187
 
# File 'quick_sight/cfn_topic.rb', line 2185

def numeric_range_filter
  @numeric_range_filter
end

#operand_field_name ⇒ String (readonly)

The name of the field that the filter operates on.

Returns:

  • (String)

See Also:



2141
2142
2143
 
# File 'quick_sight/cfn_topic.rb', line 2141

def operand_field_name
  @operand_field_name
end

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

The relative date filter.

Returns:

See Also:



2190
2191
2192
 
# File 'quick_sight/cfn_topic.rb', line 2190

def relative_date_filter
  @relative_date_filter
end

Class Method Details

.jsii_properties ⇒ Object 



2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
 
# File 'quick_sight/cfn_topic.rb', line 2192

def self.jsii_properties
  {
    :filter_name => "filterName",
    :operand_field_name => "operandFieldName",
    :category_filter => "categoryFilter",
    :date_range_filter => "dateRangeFilter",
    :filter_class => "filterClass",
    :filter_description => "filterDescription",
    :filter_synonyms => "filterSynonyms",
    :filter_type => "filterType",
    :numeric_equality_filter => "numericEqualityFilter",
    :numeric_range_filter => "numericRangeFilter",
    :relative_date_filter => "relativeDateFilter",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
 
# File 'quick_sight/cfn_topic.rb', line 2208

def to_jsii
  result = {}
  result.merge!({
    "filterName" => @filter_name,
    "operandFieldName" => @operand_field_name,
    "categoryFilter" => @category_filter,
    "dateRangeFilter" => @date_range_filter,
    "filterClass" => @filter_class,
    "filterDescription" => @filter_description,
    "filterSynonyms" => @filter_synonyms,
    "filterType" => @filter_type,
    "numericEqualityFilter" => @numeric_equality_filter,
    "numericRangeFilter" => @numeric_range_filter,
    "relativeDateFilter" => @relative_date_filter,
  })
  result.compact
end