Interface CfnKnowledgeBase.QueryGenerationTableProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.QueryGenerationTableProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.QueryGenerationTableProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 QueryGenerationTableProperty queryGenerationTableProperty = QueryGenerationTableProperty.builder()
         .name("name")
         // the properties below are optional
         .columns(List.of(QueryGenerationColumnProperty.builder()
                 .description("description")
                 .inclusion("inclusion")
                 .name("name")
                 .build()))
         .description("description")
         .inclusion("inclusion")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBase.QueryGenerationTableProperty.Builder	A builder for CfnKnowledgeBase.QueryGenerationTableProperty
static final class	CfnKnowledgeBase.QueryGenerationTableProperty.Jsii$Proxy	An implementation for CfnKnowledgeBase.QueryGenerationTableProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.QueryGenerationTableProperty.Builder	builder()
default Object	getColumns()	An array of objects, each of which defines information about a column in the table.
default String	getDescription()	A description of the table that helps the query engine understand the contents of the table.
default String	getInclusion()	Specifies whether to include or exclude the table during query generation.
String	getName()	The name of the table for which the other fields in this object apply.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-name

getColumns

@Stability(Stable)
@Nullable
default Object getColumns()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-columns

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-description

getInclusion

@Stability(Stable)
@Nullable
default String getInclusion()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-querygenerationtable.html#cfn-bedrock-knowledgebase-querygenerationtable-inclusion

builder

@Stability(Stable)
static CfnKnowledgeBase.QueryGenerationTableProperty.Builder builder()

Returns:

a CfnKnowledgeBase.QueryGenerationTableProperty.Builder of CfnKnowledgeBase.QueryGenerationTableProperty