java.lang.Object
- software.amazon.awssdk.services.kendra.model.ColumnConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ColumnConfiguration.Builder,ColumnConfiguration>
```
@Generated("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 Description

static interface ColumnConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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 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()`	For responses, this returns true if the service returned a value for the ChangeDetectingColumns property.
`boolean`	`hasFieldMappings()`	For responses, this returns true if the service returned a value for the FieldMappings property.
`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 final String documentIdColumnName()
```
    The column that provides the document's identifier.
    
    Returns:
    
    The column that provides the document's identifier.
  - documentDataColumnName
```
public final String documentDataColumnName()
```
    The column that contains the contents of the document.
    
    Returns:
    
    The column that contains the contents of the document.
  - documentTitleColumnName
```
public final String documentTitleColumnName()
```
    The column that contains the title of the document.
    
    Returns:
    
    The column that contains the title of the document.
  - hasFieldMappings
```
public final boolean hasFieldMappings()
```
    For responses, this returns true if the service returned a value for the FieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - fieldMappings
```
public final 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 API.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFieldMappings() method.
    
    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 API.
  - hasChangeDetectingColumns
```
public final boolean hasChangeDetectingColumns()
```
    For responses, this returns true if the service returned a value for the ChangeDetectingColumns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - changeDetectingColumns
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChangeDetectingColumns() method.
    
    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 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

Class ColumnConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

documentIdColumnName

documentDataColumnName

documentTitleColumnName

hasFieldMappings

fieldMappings

hasChangeDetectingColumns

changeDetectingColumns

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields