Class: Aws::QuickSight::Types::CustomFilterConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

A custom filter that filters based on a single value. This filter can be partially matched.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#category_valueString

The category value for the filter.

This field is mutually exclusive to ParameterName.

Returns:

  • (String)


6701
6702
6703
6704
6705
6706
6707
6708
6709
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6701

class CustomFilterConfiguration < Struct.new(
  :match_operator,
  :category_value,
  :select_all_options,
  :parameter_name,
  :null_option)
  SENSITIVE = []
  include Aws::Structure
end

#match_operatorString

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

Returns:

  • (String)


6701
6702
6703
6704
6705
6706
6707
6708
6709
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6701

class CustomFilterConfiguration < Struct.new(
  :match_operator,
  :category_value,
  :select_all_options,
  :parameter_name,
  :null_option)
  SENSITIVE = []
  include Aws::Structure
end

#null_optionString

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)


6701
6702
6703
6704
6705
6706
6707
6708
6709
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6701

class CustomFilterConfiguration < Struct.new(
  :match_operator,
  :category_value,
  :select_all_options,
  :parameter_name,
  :null_option)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_nameString

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

This field is mutually exclusive to CategoryValue.

Returns:

  • (String)


6701
6702
6703
6704
6705
6706
6707
6708
6709
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6701

class CustomFilterConfiguration < Struct.new(
  :match_operator,
  :category_value,
  :select_all_options,
  :parameter_name,
  :null_option)
  SENSITIVE = []
  include Aws::Structure
end

#select_all_optionsString

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

  • FILTER_ALL_VALUES

^

Returns:

  • (String)


6701
6702
6703
6704
6705
6706
6707
6708
6709
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 6701

class CustomFilterConfiguration < Struct.new(
  :match_operator,
  :category_value,
  :select_all_options,
  :parameter_name,
  :null_option)
  SENSITIVE = []
  include Aws::Structure
end