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(value="software.amazon.awssdk:codegen")
public final class DatabaseConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DatabaseConfiguration.Builder,DatabaseConfiguration>

Provides the information necessary to connect a database to an index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DatabaseConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
AclConfiguration	aclConfiguration() Information about the database column that provides information for user context filtering.
static DatabaseConfiguration.Builder	builder()
ColumnConfiguration	columnConfiguration() Information about where the index should get the document information from the database.
ConnectionConfiguration	connectionConfiguration() The information necessary to connect to a database.
DatabaseEngineType	databaseEngineType() The type of database engine that runs the database.
String	databaseEngineTypeAsString() The type of database engine that runs the database.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DatabaseConfiguration.Builder>	serializableBuilderClass()
SqlConfiguration	sqlConfiguration() Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
DatabaseConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
DataSourceVpcConfiguration	vpcConfiguration() Returns the value of the VpcConfiguration property for 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

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:

DatabaseEngineType

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:

DatabaseEngineType

connectionConfiguration

public final ConnectionConfiguration connectionConfiguration()

The information necessary to connect to a database.

Returns:

The information necessary 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DatabaseConfiguration.Builder,DatabaseConfiguration>

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)

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