software.amazon.awssdk.services.kendra.model

Class ColumnConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.ColumnConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ColumnConfiguration.Builder,ColumnConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ColumnConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ColumnConfiguration.Builder,ColumnConfiguration>

Provides information about how Amazon Kendra should use the columns of a database in an index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ColumnConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ColumnConfiguration.Builder	builder()
List<String>	changeDetectingColumns() One to five columns that indicate when a document in the database has changed.
String	documentDataColumnName() The column that contains the contents of the document.
String	documentIdColumnName() The column that provides the document's unique identifier.
String	documentTitleColumnName() The column that contains the title of the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<DataSourceToIndexFieldMapping>	fieldMappings() An array of objects that map database column names to the corresponding fields in an index.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChangeDetectingColumns() Returns true if the ChangeDetectingColumns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasFieldMappings() Returns true if the FieldMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ColumnConfiguration.Builder>	serializableBuilderClass()
ColumnConfiguration.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

documentIdColumnName

public String documentIdColumnName()

The column that provides the document's unique identifier.

Returns:

The column that provides the document's unique identifier.

documentDataColumnName

public String documentDataColumnName()

The column that contains the contents of the document.

Returns:

The column that contains the contents of the document.

documentTitleColumnName

public String documentTitleColumnName()

The column that contains the title of the document.

Returns:

The column that contains the title of the document.

hasFieldMappings

public boolean hasFieldMappings()

Returns true if the FieldMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

fieldMappings

public List<DataSourceToIndexFieldMapping> fieldMappings()

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFieldMappings() to see if a value was sent in this field.

Returns:

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.

hasChangeDetectingColumns

public boolean hasChangeDetectingColumns()

Returns true if the ChangeDetectingColumns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

changeDetectingColumns

public List<String> changeDetectingColumns()

One to five columns that indicate when a document in the database has changed.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasChangeDetectingColumns() to see if a value was sent in this field.

Returns:

One to five columns that indicate when a document in the database has changed.

toBuilder

public ColumnConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ColumnConfiguration.Builder,ColumnConfiguration>

builder

public static ColumnConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ColumnConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo