Class: Aws::QuickSight::Types::Filter

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::Filter

Includes:

Structure

Defined in:

lib/aws-sdk-quicksight/types.rb

Overview

With a ‘Filter`, you can remove portions of data from a particular visual or view.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #category_filter ⇒ Types::CategoryFilter

  A ‘CategoryFilter` filters text values.

• #nested_filter ⇒ Types::NestedFilter

  A ‘NestedFilter` filters data with a subset of data that is defined by the nested inner filter.

• #numeric_equality_filter ⇒ Types::NumericEqualityFilter

  A ‘NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value.

• #numeric_range_filter ⇒ Types::NumericRangeFilter

  A ‘NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range.

• #relative_dates_filter ⇒ Types::RelativeDatesFilter

  A ‘RelativeDatesFilter` filters date values that are relative to a given date.

• #time_equality_filter ⇒ Types::TimeEqualityFilter

  A ‘TimeEqualityFilter` filters date-time values that equal or do not equal a given date/time value.

• #time_range_filter ⇒ Types::TimeRangeFilter

  A ‘TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range.

• #top_bottom_filter ⇒ Types::TopBottomFilter

  A ‘TopBottomFilter` filters data to the top or bottom values for a given column.

Instance Attribute Details

#category_filter ⇒ Types::CategoryFilter

A ‘CategoryFilter` filters text values.

For more information, see [Adding text filters] in the *Amazon QuickSight User Guide*.

[1]: docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html

Returns:

• (Types::CategoryFilter)

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

class Filter < Struct.new(
  :category_filter,
  :numeric_range_filter,
  :numeric_equality_filter,
  :time_equality_filter,
  :time_range_filter,
  :relative_dates_filter,
  :top_bottom_filter,
  :nested_filter)
  SENSITIVE = []
  include Aws::Structure
end

#nested_filter ⇒ Types::NestedFilter

A ‘NestedFilter` filters data with a subset of data that is defined by the nested inner filter.

Returns:

• (Types::NestedFilter)

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

class Filter < Struct.new(
  :category_filter,
  :numeric_range_filter,
  :numeric_equality_filter,
  :time_equality_filter,
  :time_range_filter,
  :relative_dates_filter,
  :top_bottom_filter,
  :nested_filter)
  SENSITIVE = []
  include Aws::Structure
end

#numeric_equality_filter ⇒ Types::NumericEqualityFilter

A ‘NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value.

Returns:

• (Types::NumericEqualityFilter)

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

class Filter < Struct.new(
  :category_filter,
  :numeric_range_filter,
  :numeric_equality_filter,
  :time_equality_filter,
  :time_range_filter,
  :relative_dates_filter,
  :top_bottom_filter,
  :nested_filter)
  SENSITIVE = []
  include Aws::Structure
end

#numeric_range_filter ⇒ Types::NumericRangeFilter

A ‘NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range.

Returns:

• (Types::NumericRangeFilter)

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

class Filter < Struct.new(
  :category_filter,
  :numeric_range_filter,
  :numeric_equality_filter,
  :time_equality_filter,
  :time_range_filter,
  :relative_dates_filter,
  :top_bottom_filter,
  :nested_filter)
  SENSITIVE = []
  include Aws::Structure
end

#relative_dates_filter ⇒ Types::RelativeDatesFilter

A ‘RelativeDatesFilter` filters date values that are relative to a given date.

Returns:

• (Types::RelativeDatesFilter)

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

class Filter < Struct.new(
  :category_filter,
  :numeric_range_filter,
  :numeric_equality_filter,
  :time_equality_filter,
  :time_range_filter,
  :relative_dates_filter,
  :top_bottom_filter,
  :nested_filter)
  SENSITIVE = []
  include Aws::Structure
end

#time_equality_filter ⇒ Types::TimeEqualityFilter

A ‘TimeEqualityFilter` filters date-time values that equal or do not equal a given date/time value.

Returns:

• (Types::TimeEqualityFilter)

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

class Filter < Struct.new(
  :category_filter,
  :numeric_range_filter,
  :numeric_equality_filter,
  :time_equality_filter,
  :time_range_filter,
  :relative_dates_filter,
  :top_bottom_filter,
  :nested_filter)
  SENSITIVE = []
  include Aws::Structure
end

#time_range_filter ⇒ Types::TimeRangeFilter

A ‘TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range.

Returns:

• (Types::TimeRangeFilter)

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

class Filter < Struct.new(
  :category_filter,
  :numeric_range_filter,
  :numeric_equality_filter,
  :time_equality_filter,
  :time_range_filter,
  :relative_dates_filter,
  :top_bottom_filter,
  :nested_filter)
  SENSITIVE = []
  include Aws::Structure
end

#top_bottom_filter ⇒ Types::TopBottomFilter

A ‘TopBottomFilter` filters data to the top or bottom values for a given column.

Returns:

• (Types::TopBottomFilter)

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

class Filter < Struct.new(
  :category_filter,
  :numeric_range_filter,
  :numeric_equality_filter,
  :time_equality_filter,
  :time_range_filter,
  :relative_dates_filter,
  :top_bottom_filter,
  :nested_filter)
  SENSITIVE = []
  include Aws::Structure
end