Class: AWSCDK::QuickSight::CfnTemplate::CustomFilterConfigurationProperty

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

Overview

A custom filter that filters based on a single value.

This filter can be partially matched.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(match_operator:, null_option:, category_value: nil, parameter_name: nil, select_all_options: nil) ⇒ CustomFilterConfigurationProperty

Returns a new instance of CustomFilterConfigurationProperty.

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_value (String, nil) (defaults to: nil) —

    The category value for the filter.

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

    The parameter whose value should be used for the filter value.

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

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



5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
 
# File 'quick_sight/cfn_template.rb', line 5743

def initialize(match_operator:, null_option:, category_value: nil, parameter_name: 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_value = category_value
  Jsii::Type.check_type(@category_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "categoryValue") unless @category_value.nil?
  @parameter_name = parameter_name
  Jsii::Type.check_type(@parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterName") unless @parameter_name.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_value ⇒ String? (readonly)

The category value for the filter.

This field is mutually exclusive to ParameterName .

Returns:

  • (String, nil)

See Also:



5776
5777
5778
 
# File 'quick_sight/cfn_template.rb', line 5776

def category_value
  @category_value
end

#match_operator ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



5760
5761
5762
 
# File 'quick_sight/cfn_template.rb', line 5760

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:



5769
5770
5771
 
# File 'quick_sight/cfn_template.rb', line 5769

def null_option
  @null_option
end

#parameter_name ⇒ String? (readonly)

The parameter whose value should be used for the filter value.

This field is mutually exclusive to CategoryValue .

Returns:

  • (String, nil)

See Also:



5783
5784
5785
 
# File 'quick_sight/cfn_template.rb', line 5783

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



5790
5791
5792
 
# File 'quick_sight/cfn_template.rb', line 5790

def select_all_options
  @select_all_options
end

Class Method Details

.jsii_properties ⇒ Object 



5792
5793
5794
5795
5796
5797
5798
5799
5800
 
# File 'quick_sight/cfn_template.rb', line 5792

def self.jsii_properties
  {
    :match_operator => "matchOperator",
    :null_option => "nullOption",
    :category_value => "categoryValue",
    :parameter_name => "parameterName",
    :select_all_options => "selectAllOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
 
# File 'quick_sight/cfn_template.rb', line 5802

def to_jsii
  result = {}
  result.merge!({
    "matchOperator" => @match_operator,
    "nullOption" => @null_option,
    "categoryValue" => @category_value,
    "parameterName" => @parameter_name,
    "selectAllOptions" => @select_all_options,
  })
  result.compact
end