Class: AWSCDK::QuickSight::CfnTemplate::TopBottomRankedComputationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::TopBottomRankedComputationProperty

Defined in:

quick_sight/cfn_template.rb

Overview

The top ranked and bottom ranked computation configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html

Instance Attribute Summary

• #category ⇒ AWSCDK::IResolvable, ... readonly

  The category field that is used in a computation.

• #computation_id ⇒ String readonly

  The ID for a computation.

• #name ⇒ String^? readonly

  The name of a computation.

• #result_size ⇒ Numeric^? readonly

  The result size of a top and bottom ranked computation.

• #type ⇒ String readonly

  The computation type.

• #value ⇒ AWSCDK::IResolvable, ... readonly

  The value field that is used in a computation.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(computation_id:, type:, category: nil, name: nil, result_size: nil, value: nil) ⇒ TopBottomRankedComputationProperty constructor

  A new instance of TopBottomRankedComputationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(computation_id:, type:, category: nil, name: nil, result_size: nil, value: nil) ⇒ TopBottomRankedComputationProperty

Returns a new instance of TopBottomRankedComputationProperty.

Parameters:

• computation_id (String) —

  The ID for a computation.

• type (String) —

  The computation type. Choose one of the following options:.

• category (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::DimensionFieldProperty, nil) (defaults to: nil) —

  The category field that is used in a computation.

• name (String, nil) (defaults to: nil) —

  The name of a computation.

• result_size (Numeric, nil) (defaults to: nil) —

  The result size of a top and bottom ranked computation.

• value (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::MeasureFieldProperty, nil) (defaults to: nil) —

  The value field that is used in a computation.

# File 'quick_sight/cfn_template.rb', line 28296

def initialize(computation_id:, type:, category: nil, name: nil, result_size: nil, value: nil)
  @computation_id = computation_id
  Jsii::Type.check_type(@computation_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "computationId")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @category = category.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DimensionFieldProperty.new(**category.transform_keys(&:to_sym)) : category
  Jsii::Type.check_type(@category, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRpbWVuc2lvbkZpZWxkUHJvcGVydHkifV19fQ==")), "category") unless @category.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @result_size = result_size
  Jsii::Type.check_type(@result_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "resultSize") unless @result_size.nil?
  @value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::MeasureFieldProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLk1lYXN1cmVGaWVsZFByb3BlcnR5In1dfX0=")), "value") unless @value.nil?
end

Instance Attribute Details

#category ⇒ AWSCDK::IResolvable, ... (readonly)

The category field that is used in a computation.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::DimensionFieldProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-category

# File 'quick_sight/cfn_template.rb', line 28328

def category
  @category
end

#computation_id ⇒ String (readonly)

The ID for a computation.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-computationid

# File 'quick_sight/cfn_template.rb', line 28315

def computation_id
  @computation_id
end

#name ⇒ String^? (readonly)

The name of a computation.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-name

# File 'quick_sight/cfn_template.rb', line 28333

def name
  @name
end

#result_size ⇒ Numeric^? (readonly)

Note:

Default: - 0

The result size of a top and bottom ranked computation.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-resultsize

# File 'quick_sight/cfn_template.rb', line 28339

def result_size
  @result_size
end

#type ⇒ String (readonly)

The computation type. Choose one of the following options:.

• TOP: A top ranked computation.
• BOTTOM: A bottom ranked computation.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-type

# File 'quick_sight/cfn_template.rb', line 28323

def type
  @type
end

#value ⇒ AWSCDK::IResolvable, ... (readonly)

The value field that is used in a computation.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::MeasureFieldProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-topbottomrankedcomputation.html#cfn-quicksight-template-topbottomrankedcomputation-value

# File 'quick_sight/cfn_template.rb', line 28344

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 28346

def self.jsii_properties
  {
    :computation_id => "computationId",
    :type => "type",
    :category => "category",
    :name => "name",
    :result_size => "resultSize",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 28357

def to_jsii
  result = {}
  result.merge!({
    "computationId" => @computation_id,
    "type" => @type,
    "category" => @category,
    "name" => @name,
    "resultSize" => @result_size,
    "value" => @value,
  })
  result.compact
end