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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SqlKnowledgeBaseConfiguration.Builder,SqlKnowledgeBaseConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.