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

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::CustomFilterConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #category_value ⇒ String

  The category value for the filter.

• #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.

• #parameter_name ⇒ String

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

• #select_all_options ⇒ String

  Select all of the values.

Instance Attribute Details

#category_value ⇒ String

The category value for the filter.

This field is mutually exclusive to ‘ParameterName`.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 7175

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

#match_operator ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 7175

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

#null_option ⇒ String

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)

# File 'lib/aws-sdk-quicksight/types.rb', line 7175

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

#parameter_name ⇒ String

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

This field is mutually exclusive to ‘CategoryValue`.

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 7175

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

#select_all_options ⇒ String

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

• ‘FILTER_ALL_VALUES`

^

Returns:

• (String)

# File 'lib/aws-sdk-quicksight/types.rb', line 7175

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