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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SqlConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SqlConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
QueryIdentifiersEnclosingOption	queryIdentifiersEnclosingOption()	Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.
String	queryIdentifiersEnclosingOptionAsString()	Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when making a database query.
List<SdkField<?>>	sdkFields()
static Class<? extends SqlConfiguration.Builder>	serializableBuilderClass()
SqlConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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:

QueryIdentifiersEnclosingOption

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:

QueryIdentifiersEnclosingOption

toBuilder

public SqlConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SqlConfiguration.Builder,SqlConfiguration>

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)

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