Class: AWSCDK::QuickSight::CfnTopic::TopicNamedEntityProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTopic::TopicNamedEntityProperty

Defined in:

quick_sight/cfn_topic.rb

Overview

A structure that represents a named entity.

See Also:

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

Instance Attribute Summary

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

  The definition of a named entity.

• #entity_description ⇒ String^? readonly

  The description of the named entity.

• #entity_name ⇒ String readonly

  The name of the named entity.

• #entity_synonyms ⇒ Array<String>^? readonly

  The other names or aliases for the named entity.

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

  The type of named entity that a topic represents.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(entity_name:, definition: nil, entity_description: nil, entity_synonyms: nil, semantic_entity_type: nil) ⇒ TopicNamedEntityProperty constructor

  A new instance of TopicNamedEntityProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(entity_name:, definition: nil, entity_description: nil, entity_synonyms: nil, semantic_entity_type: nil) ⇒ TopicNamedEntityProperty

Returns a new instance of TopicNamedEntityProperty.

Parameters:

• entity_name (String) —

  The name of the named entity.

• definition (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::NamedEntityDefinitionProperty>, nil) (defaults to: nil) —

  The definition of a named entity.

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

  The description of the named entity.

• entity_synonyms (Array<String>, nil) (defaults to: nil) —

  The other names or aliases for the named entity.

• semantic_entity_type (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::SemanticEntityTypeProperty, nil) (defaults to: nil) —

  The type of named entity that a topic represents.

# File 'quick_sight/cfn_topic.rb', line 2238

def initialize(entity_name:, definition: nil, entity_description: nil, entity_synonyms: nil, semantic_entity_type: nil)
  @entity_name = entity_name
  Jsii::Type.check_type(@entity_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "entityName")
  @definition = definition
  Jsii::Type.check_type(@definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5Ub3BpYy5OYW1lZEVudGl0eURlZmluaXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "definition") unless @definition.nil?
  @entity_description = entity_description
  Jsii::Type.check_type(@entity_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "entityDescription") unless @entity_description.nil?
  @entity_synonyms = entity_synonyms
  Jsii::Type.check_type(@entity_synonyms, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "entitySynonyms") unless @entity_synonyms.nil?
  @semantic_entity_type = semantic_entity_type.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::SemanticEntityTypeProperty.new(**semantic_entity_type.transform_keys(&:to_sym)) : semantic_entity_type
  Jsii::Type.check_type(@semantic_entity_type, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlNlbWFudGljRW50aXR5VHlwZVByb3BlcnR5In1dfX0=")), "semanticEntityType") unless @semantic_entity_type.nil?
end

Instance Attribute Details

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

The definition of a named entity.

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::NamedEntityDefinitionProperty>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-definition

# File 'quick_sight/cfn_topic.rb', line 2260

def definition
  @definition
end

#entity_description ⇒ String^? (readonly)

The description of the named entity.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitydescription

# File 'quick_sight/cfn_topic.rb', line 2265

def entity_description
  @entity_description
end

#entity_name ⇒ String (readonly)

The name of the named entity.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entityname

# File 'quick_sight/cfn_topic.rb', line 2255

def entity_name
  @entity_name
end

#entity_synonyms ⇒ Array<String>^? (readonly)

The other names or aliases for the named entity.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-entitysynonyms

# File 'quick_sight/cfn_topic.rb', line 2270

def entity_synonyms
  @entity_synonyms
end

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

The type of named entity that a topic represents.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::SemanticEntityTypeProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topicnamedentity.html#cfn-quicksight-topic-topicnamedentity-semanticentitytype

# File 'quick_sight/cfn_topic.rb', line 2275

def semantic_entity_type
  @semantic_entity_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 2277

def self.jsii_properties
  {
    :entity_name => "entityName",
    :definition => "definition",
    :entity_description => "entityDescription",
    :entity_synonyms => "entitySynonyms",
    :semantic_entity_type => "semanticEntityType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_topic.rb', line 2287

def to_jsii
  result = {}
  result.merge!({
    "entityName" => @entity_name,
    "definition" => @definition,
    "entityDescription" => @entity_description,
    "entitySynonyms" => @entity_synonyms,
    "semanticEntityType" => @semantic_entity_type,
  })
  result.compact
end