Class: Aws::QuickSight::Types::TopicFilter

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::TopicFilter

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

A structure that represents a filter used to select items for a topic.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:filter_description, :filter_synonyms]

Instance Attribute Summary

• #category_filter ⇒ Types::TopicCategoryFilter

  The category filter that is associated with this filter.

• #date_range_filter ⇒ Types::TopicDateRangeFilter

  The date range filter.

• #filter_class ⇒ String

  The class of the filter.

• #filter_description ⇒ String

  A description of the filter used to select items for a topic.

• #filter_name ⇒ String

  The name of the filter.

• #filter_synonyms ⇒ Array<String>

  The other names or aliases for the filter.

• #filter_type ⇒ String

  The type of the filter.

• #null_filter ⇒ Types::TopicNullFilter

  The null filter.

• #numeric_equality_filter ⇒ Types::TopicNumericEqualityFilter

  The numeric equality filter.

• #numeric_range_filter ⇒ Types::TopicNumericRangeFilter

  The numeric range filter.

• #operand_field_name ⇒ String

  The name of the field that the filter operates on.

• #relative_date_filter ⇒ Types::TopicRelativeDateFilter

  The relative date filter.

Instance Attribute Details

#category_filter ⇒ Types::TopicCategoryFilter

The category filter that is associated with this filter.

Returns:

• (Types::TopicCategoryFilter)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#date_range_filter ⇒ Types::TopicDateRangeFilter

The date range filter.

Returns:

• (Types::TopicDateRangeFilter)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#filter_class ⇒ String

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

Returns:

• (String)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#filter_description ⇒ String

A description of the filter used to select items for a topic.

Returns:

• (String)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#filter_name ⇒ String

The name of the filter.

Returns:

• (String)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#filter_synonyms ⇒ Array<String>

The other names or aliases for the filter.

Returns:

• (Array<String>)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#filter_type ⇒ String

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

Returns:

• (String)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#null_filter ⇒ Types::TopicNullFilter

The null filter.

Returns:

• (Types::TopicNullFilter)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#numeric_equality_filter ⇒ Types::TopicNumericEqualityFilter

The numeric equality filter.

Returns:

• (Types::TopicNumericEqualityFilter)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#numeric_range_filter ⇒ Types::TopicNumericRangeFilter

The numeric range filter.

Returns:

• (Types::TopicNumericRangeFilter)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#operand_field_name ⇒ String

The name of the field that the filter operates on.

Returns:

• (String)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end

#relative_date_filter ⇒ Types::TopicRelativeDateFilter

The relative date filter.

Returns:

• (Types::TopicRelativeDateFilter)

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

class TopicFilter < Struct.new(
  :filter_description,
  :filter_class,
  :filter_name,
  :filter_synonyms,
  :operand_field_name,
  :filter_type,
  :category_filter,
  :numeric_equality_filter,
  :numeric_range_filter,
  :date_range_filter,
  :relative_date_filter,
  :null_filter)
  SENSITIVE = [:filter_description, :filter_synonyms]
  include Aws::Structure
end