Class: Aws::QuickSight::Types::RelativeDatesFilter

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::RelativeDatesFilter

Defined in:

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

Overview

A RelativeDatesFilter filters relative dates values.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #anchor_date_configuration ⇒ Types::AnchorDateConfiguration

  The date configuration of the filter.

• #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 configuration for the exclude period of the filter.

• #filter_id ⇒ String

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

• #minimum_granularity ⇒ String

  The minimum granularity (period granularity) of the relative dates filter.

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

• #relative_date_type ⇒ String

  The range date type of the filter.

• #relative_date_value ⇒ Integer

  The date value of the filter.

• #time_granularity ⇒ String

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

Instance Attribute Details

#anchor_date_configuration ⇒ Types::AnchorDateConfiguration

The date configuration of the filter.

Returns:

• (Types::AnchorDateConfiguration)

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

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#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 39112

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :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 39112

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_period_configuration ⇒ Types::ExcludePeriodConfiguration

The configuration for the exclude period of the filter.

Returns:

• (Types::ExcludePeriodConfiguration)

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

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :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 39112

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#minimum_granularity ⇒ String

The minimum granularity (period granularity) of the relative dates filter.

Returns:

• (String)

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

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :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 39112

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_name ⇒ String

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

Returns:

• (String)

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

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#relative_date_type ⇒ String

The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

Returns:

• (String)

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

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#relative_date_value ⇒ Integer

The date value of the filter.

Returns:

• (Integer)

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

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :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 39112

class RelativeDatesFilter < Struct.new(
  :filter_id,
  :column,
  :anchor_date_configuration,
  :minimum_granularity,
  :time_granularity,
  :relative_date_type,
  :relative_date_value,
  :parameter_name,
  :null_option,
  :exclude_period_configuration,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end