Class: Aws::QuickSight::Types::TopicIRMetric

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::TopicIRMetric

Defined in:

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

Overview

The definition for a TopicIRMetric.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:expression]

Instance Attribute Summary

• #calculated_field_references ⇒ Array<Types::Identifier>

  The calculated field references for the TopicIRMetric.

• #comparison_method ⇒ Types::TopicIRComparisonMethod

  The comparison method for the TopicIRMetric.

• #display_format ⇒ String

  The display format for the TopicIRMetric.

• #display_format_options ⇒ Types::DisplayFormatOptions

  A structure that represents additional options for display formatting.

• #expression ⇒ String

  The expression for the TopicIRMetric.

• #function ⇒ Types::AggFunction

  The function for the TopicIRMetric.

• #metric_id ⇒ Types::Identifier

  The metric ID for the TopicIRMetric.

• #named_entity ⇒ Types::NamedEntityRef

  The named entity for the TopicIRMetric.

• #operands ⇒ Array<Types::Identifier>

  The operands for the TopicIRMetric.

Instance Attribute Details

#calculated_field_references ⇒ Array<Types::Identifier>

The calculated field references for the TopicIRMetric.

Returns:

• (Array<Types::Identifier>)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#comparison_method ⇒ Types::TopicIRComparisonMethod

The comparison method for the TopicIRMetric.

Returns:

• (Types::TopicIRComparisonMethod)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#display_format ⇒ String

The display format for the TopicIRMetric.

Returns:

• (String)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#display_format_options ⇒ Types::DisplayFormatOptions

A structure that represents additional options for display formatting.

Returns:

• (Types::DisplayFormatOptions)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#expression ⇒ String

The expression for the TopicIRMetric.

Returns:

• (String)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#function ⇒ Types::AggFunction

The function for the TopicIRMetric.

Returns:

• (Types::AggFunction)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#metric_id ⇒ Types::Identifier

The metric ID for the TopicIRMetric.

Returns:

• (Types::Identifier)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#named_entity ⇒ Types::NamedEntityRef

The named entity for the TopicIRMetric.

Returns:

• (Types::NamedEntityRef)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#operands ⇒ Array<Types::Identifier>

The operands for the TopicIRMetric.

Returns:

• (Array<Types::Identifier>)

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

class TopicIRMetric < Struct.new(
  :metric_id,
  :function,
  :operands,
  :comparison_method,
  :expression,
  :calculated_field_references,
  :display_format,
  :display_format_options,
  :named_entity)
  SENSITIVE = [:expression]
  include Aws::Structure
end