Class: AWSCDK::QuickSight::CfnAnalysis::TableFieldOptionProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_analysis.rb

Overview

The options for a table field.

See Also:

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

Instance Attribute Summary

• #custom_label ⇒ String^? readonly

  The custom label for a table field.

• #field_id ⇒ String readonly

  The field ID for a table field.

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

  The URL configuration for a table field.

• #visibility ⇒ String^? readonly

  The visibility of a table field.

• #width ⇒ String^? readonly

  The width for a table field.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_id:, custom_label: nil, url_styling: nil, visibility: nil, width: nil) ⇒ TableFieldOptionProperty constructor

  A new instance of TableFieldOptionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_id:, custom_label: nil, url_styling: nil, visibility: nil, width: nil) ⇒ TableFieldOptionProperty

Returns a new instance of TableFieldOptionProperty.

Parameters:

• field_id (String) —

  The field ID for a table field.

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

  The custom label for a table field.

• url_styling (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnAnalysis::TableFieldURLConfigurationProperty, nil) (defaults to: nil) —

  The URL configuration for a table field.

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

  The visibility of a table field.

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

  The width for a table field.

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

def initialize(field_id:, custom_label: nil, url_styling: nil, visibility: nil, width: nil)
  @field_id = field_id
  Jsii::Type.check_type(@field_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldId")
  @custom_label = custom_label
  Jsii::Type.check_type(@custom_label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customLabel") unless @custom_label.nil?
  @url_styling = url_styling.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TableFieldURLConfigurationProperty.new(**url_styling.transform_keys(&:to_sym)) : url_styling
  Jsii::Type.check_type(@url_styling, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRhYmxlRmllbGRVUkxDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "urlStyling") unless @url_styling.nil?
  @visibility = visibility
  Jsii::Type.check_type(@visibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visibility") unless @visibility.nil?
  @width = width
  Jsii::Type.check_type(@width, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "width") unless @width.nil?
end

Instance Attribute Details

#custom_label ⇒ String^? (readonly)

The custom label for a table field.

Returns:

• (String, nil)

See Also:

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

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

def custom_label
  @custom_label
end

#field_id ⇒ String (readonly)

The field ID for a table field.

Returns:

• (String)

See Also:

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

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

def field_id
  @field_id
end

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

The URL configuration for a table field.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnAnalysis::TableFieldURLConfigurationProperty, nil)

See Also:

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

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

def url_styling
  @url_styling
end

#visibility ⇒ String^? (readonly)

The visibility of a table field.

Returns:

• (String, nil)

See Also:

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

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

def visibility
  @visibility
end

#width ⇒ String^? (readonly)

The width for a table field.

Returns:

• (String, nil)

See Also:

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

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

def width
  @width
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :field_id => "fieldId",
    :custom_label => "customLabel",
    :url_styling => "urlStyling",
    :visibility => "visibility",
    :width => "width",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "fieldId" => @field_id,
    "customLabel" => @custom_label,
    "urlStyling" => @url_styling,
    "visibility" => @visibility,
    "width" => @width,
  })
  result.compact
end