Class: AWSCDK::QuickSight::CfnDashboard::CustomFilterListConfigurationProperty

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

Overview

A list of custom filter values.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(match_operator:, null_option:, category_values: nil, select_all_options: nil) ⇒ CustomFilterListConfigurationProperty

Returns a new instance of CustomFilterListConfigurationProperty.

Parameters:

  • match_operator (String) —

    The match operator that is used to determine if a filter should be applied.

  • null_option (String) —

    This option determines how null values should be treated when filtering data.

  • category_values (Array<String>, nil) (defaults to: nil) —

    The list of category values for the filter.

  • select_all_options (String, nil) (defaults to: nil) —

    Select all of the values. Null is not the assigned value of select all.



5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
 
# File 'quick_sight/cfn_dashboard.rb', line 5840

def initialize(match_operator:, null_option:, category_values: nil, select_all_options: nil)
  @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")
  @category_values = category_values
  Jsii::Type.check_type(@category_values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "categoryValues") unless @category_values.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?
end

Instance Attribute Details

#category_values ⇒ Array<String>? (readonly)

The list of category values for the filter.

Returns:

  • (Array<String>, nil)

See Also:



5869
5870
5871
 
# File 'quick_sight/cfn_dashboard.rb', line 5869

def category_values
  @category_values
end

#match_operator ⇒ String (readonly)

The match operator that is used to determine if a filter should be applied.

Returns:

  • (String)

See Also:



5855
5856
5857
 
# File 'quick_sight/cfn_dashboard.rb', line 5855

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:



5864
5865
5866
 
# File 'quick_sight/cfn_dashboard.rb', line 5864

def null_option
  @null_option
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:



5876
5877
5878
 
# File 'quick_sight/cfn_dashboard.rb', line 5876

def select_all_options
  @select_all_options
end

Class Method Details

.jsii_properties ⇒ Object 



5878
5879
5880
5881
5882
5883
5884
5885
 
# File 'quick_sight/cfn_dashboard.rb', line 5878

def self.jsii_properties
  {
    :match_operator => "matchOperator",
    :null_option => "nullOption",
    :category_values => "categoryValues",
    :select_all_options => "selectAllOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
 
# File 'quick_sight/cfn_dashboard.rb', line 5887

def to_jsii
  result = {}
  result.merge!({
    "matchOperator" => @match_operator,
    "nullOption" => @null_option,
    "categoryValues" => @category_values,
    "selectAllOptions" => @select_all_options,
  })
  result.compact
end