Class: AWSCDK::Bedrock::CfnKnowledgeBase::QueryGenerationColumnProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_knowledge_base.rb

Overview

Contains information about a column in the current table for the query engine to consider.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, inclusion: nil, name: nil) ⇒ QueryGenerationColumnProperty

Returns a new instance of QueryGenerationColumnProperty.

Parameters:

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

    A description of the column that helps the query engine understand the contents of the column.

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

    Specifies whether to include or exclude the column during query generation.

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

    The name of the column for which the other fields in this object apply.



1671
1672
1673
1674
1675
1676
1677
1678
 
# File 'bedrock/cfn_knowledge_base.rb', line 1671

def initialize(description: nil, inclusion: nil, name: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @inclusion = inclusion
  Jsii::Type.check_type(@inclusion, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inclusion") unless @inclusion.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A description of the column that helps the query engine understand the contents of the column.

Returns:

  • (String, nil)

See Also:



1684
1685
1686
 
# File 'bedrock/cfn_knowledge_base.rb', line 1684

def description
  @description
end

#inclusion ⇒ String? (readonly)

Specifies whether to include or exclude the column during query generation.

If you specify EXCLUDE , the column will be ignored. If you specify INCLUDE , all other columns in the table will be ignored.

Returns:

  • (String, nil)

See Also:



1691
1692
1693
 
# File 'bedrock/cfn_knowledge_base.rb', line 1691

def inclusion
  @inclusion
end

#name ⇒ String? (readonly)

The name of the column for which the other fields in this object apply.

Returns:

  • (String, nil)

See Also:



1696
1697
1698
 
# File 'bedrock/cfn_knowledge_base.rb', line 1696

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



1698
1699
1700
1701
1702
1703
1704
 
# File 'bedrock/cfn_knowledge_base.rb', line 1698

def self.jsii_properties
  {
    :description => "description",
    :inclusion => "inclusion",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1706
1707
1708
1709
1710
1711
1712
1713
1714
 
# File 'bedrock/cfn_knowledge_base.rb', line 1706

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "inclusion" => @inclusion,
    "name" => @name,
  })
  result.compact
end