Class: AWSCDK::QuickSight::CfnAnalysis::DataPathLabelTypeProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnAnalysis::DataPathLabelTypeProperty

Defined in:

quick_sight/cfn_analysis.rb

Overview

The option that specifies individual data values for labels.

See Also:

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

Instance Attribute Summary

• #field_id ⇒ String^? readonly

  The field ID of the field that the data label needs to be applied to.

• #field_value ⇒ String^? readonly

  The actual value of the field that is labeled.

• #visibility ⇒ String^? readonly

  The visibility of the data label.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_id: nil, field_value: nil, visibility: nil) ⇒ DataPathLabelTypeProperty constructor

  A new instance of DataPathLabelTypeProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_id: nil, field_value: nil, visibility: nil) ⇒ DataPathLabelTypeProperty

Returns a new instance of DataPathLabelTypeProperty.

Parameters:

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

  The field ID of the field that the data label needs to be applied to.

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

  The actual value of the field that is labeled.

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

  The visibility of the data label.

# File 'quick_sight/cfn_analysis.rb', line 6591

def initialize(field_id: nil, field_value: nil, visibility: nil)
  @field_id = field_id
  Jsii::Type.check_type(@field_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldId") unless @field_id.nil?
  @field_value = field_value
  Jsii::Type.check_type(@field_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldValue") unless @field_value.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
end

Instance Attribute Details

#field_id ⇒ String^? (readonly)

The field ID of the field that the data label needs to be applied to.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathlabeltype.html#cfn-quicksight-analysis-datapathlabeltype-fieldid

# File 'quick_sight/cfn_analysis.rb', line 6604

def field_id
  @field_id
end

#field_value ⇒ String^? (readonly)

The actual value of the field that is labeled.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathlabeltype.html#cfn-quicksight-analysis-datapathlabeltype-fieldvalue

# File 'quick_sight/cfn_analysis.rb', line 6609

def field_value
  @field_value
end

#visibility ⇒ String^? (readonly)

The visibility of the data label.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datapathlabeltype.html#cfn-quicksight-analysis-datapathlabeltype-visibility

# File 'quick_sight/cfn_analysis.rb', line 6614

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_analysis.rb', line 6616

def self.jsii_properties
  {
    :field_id => "fieldId",
    :field_value => "fieldValue",
    :visibility => "visibility",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_analysis.rb', line 6624

def to_jsii
  result = {}
  result.merge!({
    "fieldId" => @field_id,
    "fieldValue" => @field_value,
    "visibility" => @visibility,
  })
  result.compact
end