Package software.amazon.awssdk.services.bedrockagent.model

Class SqlKnowledgeBaseConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.SqlKnowledgeBaseConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SqlKnowledgeBaseConfiguration.Builder,SqlKnowledgeBaseConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class SqlKnowledgeBaseConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SqlKnowledgeBaseConfiguration.Builder,SqlKnowledgeBaseConfiguration>

Contains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the type field and include the corresponding field. For more information, see Build a knowledge base by connecting to a structured data source in the Amazon Bedrock User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SqlKnowledgeBaseConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SqlKnowledgeBaseConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RedshiftConfiguration	redshiftConfiguration()	Specifies configurations for a knowledge base connected to an Amazon Redshift database.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SqlKnowledgeBaseConfiguration.Builder>	serializableBuilderClass()
SqlKnowledgeBaseConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
QueryEngineType	type()	The type of SQL database to connect to the knowledge base.
String	typeAsString()	The type of SQL database to connect to the knowledge base.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

public final QueryEngineType type()

The type of SQL database to connect to the knowledge base.

If the service returns an enum value that is not available in the current SDK version, type will return QueryEngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of SQL database to connect to the knowledge base.

See Also:

QueryEngineType

typeAsString

public final String typeAsString()

The type of SQL database to connect to the knowledge base.

If the service returns an enum value that is not available in the current SDK version, type will return QueryEngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of SQL database to connect to the knowledge base.

See Also:

QueryEngineType

redshiftConfiguration

public final RedshiftConfiguration redshiftConfiguration()

Specifies configurations for a knowledge base connected to an Amazon Redshift database.

Returns:

Specifies configurations for a knowledge base connected to an Amazon Redshift database.

toBuilder

public SqlKnowledgeBaseConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SqlKnowledgeBaseConfiguration.Builder,SqlKnowledgeBaseConfiguration>

builder

public static SqlKnowledgeBaseConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SqlKnowledgeBaseConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo