Class: AWSCDK::QuickSight::CfnDashboard::FilterListConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDashboard::FilterListConfigurationProperty

Defined in:

quick_sight/cfn_dashboard.rb

Overview

A list of filter configurations.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html

Instance Attribute Summary

• #category_values ⇒ Array<String>^? readonly

  The list of category values for the filter.

• #match_operator ⇒ String readonly

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

• #null_option ⇒ String^? readonly

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

• #select_all_options ⇒ String^? readonly

  Select all of the values.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(match_operator:, category_values: nil, null_option: nil, select_all_options: nil) ⇒ FilterListConfigurationProperty constructor

  A new instance of FilterListConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

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

Returns a new instance of FilterListConfigurationProperty.

Parameters:

• match_operator (String) —

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

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

  The list of category values for the filter.

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

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

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

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

# File 'quick_sight/cfn_dashboard.rb', line 10918

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

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-categoryvalues

# File 'quick_sight/cfn_dashboard.rb', line 10938

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-matchoperator

# File 'quick_sight/cfn_dashboard.rb', line 10933

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, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-nulloption

# File 'quick_sight/cfn_dashboard.rb', line 10947

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-filterlistconfiguration.html#cfn-quicksight-dashboard-filterlistconfiguration-selectalloptions

# File 'quick_sight/cfn_dashboard.rb', line 10954

def select_all_options
  @select_all_options
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 10956

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

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 10965

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