Package software.amazon.awssdk.services.kendra.model

Class DatabaseConfiguration

java.lang.Object
software.amazon.awssdk.services.kendra.model.DatabaseConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DatabaseConfiguration.Builder,DatabaseConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class DatabaseConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DatabaseConfiguration.Builder,DatabaseConfiguration>

Provides the configuration information to an Amazon Kendra supported database.

See Also:

  • Method Details

    • databaseEngineType

      public final DatabaseEngineType databaseEngineType()

      The type of database engine that runs the database.

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

      Returns:
      The type of database engine that runs the database.
      See Also:

    • databaseEngineTypeAsString

      public final String databaseEngineTypeAsString()

      The type of database engine that runs the database.

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

      Returns:
      The type of database engine that runs the database.
      See Also:

    • connectionConfiguration

      public final ConnectionConfiguration connectionConfiguration()

      Configuration information that's required to connect to a database.

      Returns:
      Configuration information that's required to connect to a database.

    • vpcConfiguration

      public final DataSourceVpcConfiguration vpcConfiguration()
      Returns the value of the VpcConfiguration property for this object.
      Returns:
      The value of the VpcConfiguration property for this object.

    • columnConfiguration

      public final ColumnConfiguration columnConfiguration()

      Information about where the index should get the document information from the database.

      Returns:
      Information about where the index should get the document information from the database.

    • aclConfiguration

      public final AclConfiguration aclConfiguration()

      Information about the database column that provides information for user context filtering.

      Returns:
      Information about the database column that provides information for user context filtering.

    • sqlConfiguration

      public final SqlConfiguration sqlConfiguration()

      Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

      Returns:
      Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

    • toBuilder

      public DatabaseConfiguration.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<DatabaseConfiguration.Builder,DatabaseConfiguration>
      Returns:
      a builder for type T

    • builder

      public static DatabaseConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DatabaseConfiguration.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.