Class: Aws::QuickSight::Types::TimeRangeFilter

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::TimeRangeFilter

Defined in:

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

Overview

A TimeRangeFilter filters values that are between two specified values.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #column ⇒ Types::ColumnIdentifier

  The column that the filter is applied to.

• #default_filter_control_configuration ⇒ Types::DefaultFilterControlConfiguration

  The default configurations for the associated controls.

• #exclude_period_configuration ⇒ Types::ExcludePeriodConfiguration

  The exclude period of the time range filter.

• #filter_id ⇒ String

  An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

• #include_maximum ⇒ Boolean

  Determines whether the maximum value in the filter value range should be included in the filtered results.

• #include_minimum ⇒ Boolean

  Determines whether the minimum value in the filter value range should be included in the filtered results.

• #null_option ⇒ String

  This option determines how null values should be treated when filtering data.

• #range_maximum_value ⇒ Types::TimeRangeFilterValue

  The maximum value for the filter value range.

• #range_minimum_value ⇒ Types::TimeRangeFilterValue

  The minimum value for the filter value range.

• #time_granularity ⇒ String

  The level of time precision that is used to aggregate DateTime values.

Instance Attribute Details

#column ⇒ Types::ColumnIdentifier

The column that the filter is applied to.

Returns:

• (Types::ColumnIdentifier)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#default_filter_control_configuration ⇒ Types::DefaultFilterControlConfiguration

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

Returns:

• (Types::DefaultFilterControlConfiguration)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_period_configuration ⇒ Types::ExcludePeriodConfiguration

The exclude period of the time range filter.

Returns:

• (Types::ExcludePeriodConfiguration)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#filter_id ⇒ String

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Returns:

• (String)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#include_maximum ⇒ Boolean

Determines whether the maximum value in the filter value range should be included in the filtered results.

Returns:

• (Boolean)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#include_minimum ⇒ Boolean

Determines whether the minimum value in the filter value range should be included in the filtered results.

Returns:

• (Boolean)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  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 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 47263

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#range_maximum_value ⇒ Types::TimeRangeFilterValue

The maximum value for the filter value range.

Returns:

• (Types::TimeRangeFilterValue)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#range_minimum_value ⇒ Types::TimeRangeFilterValue

The minimum value for the filter value range.

Returns:

• (Types::TimeRangeFilterValue)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#time_granularity ⇒ String

The level of time precision that is used to aggregate DateTime values.

Returns:

• (String)

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

class TimeRangeFilter < Struct.new(
  :filter_id,
  :column,
  :include_minimum,
  :include_maximum,
  :range_minimum_value,
  :range_maximum_value,
  :null_option,
  :exclude_period_configuration,
  :time_granularity,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end