Class: Aws::QuickSight::Types::TimeEqualityFilter

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::TimeEqualityFilter

Defined in:

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

Overview

A TimeEqualityFilter filters values that are equal to a given value.

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.

• #filter_id ⇒ String

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

• #parameter_name ⇒ String

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

• #rolling_date ⇒ Types::RollingDateConfiguration

  The rolling date input for the TimeEquality filter.

• #time_granularity ⇒ String

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

• #value ⇒ Time

  The value of a TimeEquality filter.

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 46228

class TimeEqualityFilter < Struct.new(
  :filter_id,
  :column,
  :value,
  :parameter_name,
  :time_granularity,
  :rolling_date,
  :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 46228

class TimeEqualityFilter < Struct.new(
  :filter_id,
  :column,
  :value,
  :parameter_name,
  :time_granularity,
  :rolling_date,
  :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 46228

class TimeEqualityFilter < Struct.new(
  :filter_id,
  :column,
  :value,
  :parameter_name,
  :time_granularity,
  :rolling_date,
  :default_filter_control_configuration)
  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 Value and RollingDate.

Returns:

• (String)

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

class TimeEqualityFilter < Struct.new(
  :filter_id,
  :column,
  :value,
  :parameter_name,
  :time_granularity,
  :rolling_date,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#rolling_date ⇒ Types::RollingDateConfiguration

The rolling date input for the TimeEquality filter.

This field is mutually exclusive to Value and ParameterName.

Returns:

• (Types::RollingDateConfiguration)

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

class TimeEqualityFilter < Struct.new(
  :filter_id,
  :column,
  :value,
  :parameter_name,
  :time_granularity,
  :rolling_date,
  :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 46228

class TimeEqualityFilter < Struct.new(
  :filter_id,
  :column,
  :value,
  :parameter_name,
  :time_granularity,
  :rolling_date,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Time

The value of a TimeEquality filter.

This field is mutually exclusive to RollingDate and ParameterName.

Returns:

• (Time)

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

class TimeEqualityFilter < Struct.new(
  :filter_id,
  :column,
  :value,
  :parameter_name,
  :time_granularity,
  :rolling_date,
  :default_filter_control_configuration)
  SENSITIVE = []
  include Aws::Structure
end