Class: AWSCDK::Bedrock::CfnKnowledgeBase::QueryGenerationTableProperty

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

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, columns: nil, description: nil, inclusion: nil) ⇒ QueryGenerationTableProperty

Returns a new instance of QueryGenerationTableProperty.

Parameters:

  • name (String) —

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

  • columns (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Bedrock::CfnKnowledgeBase::QueryGenerationColumnProperty>, nil) (defaults to: nil) —

    An array of objects, each of which defines information about a column in the table.

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

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

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

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



1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
 
# File 'bedrock/cfn_knowledge_base.rb', line 1815

def initialize(name:, columns: nil, description: nil, inclusion: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @columns = columns
  Jsii::Type.check_type(@columns, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9jay5DZm5Lbm93bGVkZ2VCYXNlLlF1ZXJ5R2VuZXJhdGlvbkNvbHVtblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "columns") unless @columns.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?
end

Instance Attribute Details

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

An array of objects, each of which defines information about a column in the table.

Returns:

See Also:



1835
1836
1837
 
# File 'bedrock/cfn_knowledge_base.rb', line 1835

def columns
  @columns
end

#description ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1840
1841
1842
 
# File 'bedrock/cfn_knowledge_base.rb', line 1840

def description
  @description
end

#inclusion ⇒ String? (readonly)

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

If you specify EXCLUDE , the table will be ignored. If you specify INCLUDE , all other tables will be ignored.

Returns:

  • (String, nil)

See Also:



1847
1848
1849
 
# File 'bedrock/cfn_knowledge_base.rb', line 1847

def inclusion
  @inclusion
end

#name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1830
1831
1832
 
# File 'bedrock/cfn_knowledge_base.rb', line 1830

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'bedrock/cfn_knowledge_base.rb', line 1849

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

Instance Method Details

#to_jsii ⇒ Object 



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'bedrock/cfn_knowledge_base.rb', line 1858

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