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

Class SqlConfiguration

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

Provides the configuration information to use a SQL database.

See Also:

  • Method Details

    • queryIdentifiersEnclosingOption

      public final QueryIdentifiersEnclosingOption queryIdentifiersEnclosingOption()

      Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

      By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

      PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

      For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

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

      Returns:
      Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

      By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

      PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

      For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

      See Also:

    • queryIdentifiersEnclosingOptionAsString

      public final String queryIdentifiersEnclosingOptionAsString()

      Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

      By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

      PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

      For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

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

      Returns:
      Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.

      By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source configuration. It does not change the case of identifiers or enclose them in quotes.

      PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's case.

      For MySQL databases, you must enable the ansi_quotes option when you set this field to DOUBLE_QUOTES.

      See Also:

    • toBuilder

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

    • builder

      public static SqlConfiguration.Builder builder()

    • serializableBuilderClass

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