Class: AWSCDK::QuickSight::CfnDashboard::DataPathLabelTypeProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.rb

Overview

The option that specifies individual data values for labels.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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.



7045
7046
7047
7048
7049
7050
7051
7052
 
# File 'quick_sight/cfn_dashboard.rb', line 7045

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:



7058
7059
7060
 
# File 'quick_sight/cfn_dashboard.rb', line 7058

def field_id
  @field_id
end

#field_value ⇒ String? (readonly)

The actual value of the field that is labeled.

Returns:

  • (String, nil)

See Also:



7063
7064
7065
 
# File 'quick_sight/cfn_dashboard.rb', line 7063

def field_value
  @field_value
end

#visibility ⇒ String? (readonly)

The visibility of the data label.

Returns:

  • (String, nil)

See Also:



7068
7069
7070
 
# File 'quick_sight/cfn_dashboard.rb', line 7068

def visibility
  @visibility
end

Class Method Details

.jsii_properties ⇒ Object 



7070
7071
7072
7073
7074
7075
7076
 
# File 'quick_sight/cfn_dashboard.rb', line 7070

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

Instance Method Details

#to_jsii ⇒ Object 



7078
7079
7080
7081
7082
7083
7084
7085
7086
 
# File 'quick_sight/cfn_dashboard.rb', line 7078

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