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

Class DataSourceToIndexFieldMapping

java.lang.Object

software.amazon.awssdk.services.kendra.model.DataSourceToIndexFieldMapping

All Implemented Interfaces:

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

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

Maps attributes or field names of the documents synced from the data source to Amazon Kendra index field names. You can set up field mappings for each data source when calling CreateDataSource or UpdateDataSource API. To create custom fields, use the UpdateIndex API to first create an index field and then map to the data source field. For more information, see Mapping data source fields.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataSourceToIndexFieldMapping.Builder

Method Summary

Modifier and Type	Method	Description
static DataSourceToIndexFieldMapping.Builder	builder()
String	dataSourceFieldName()	The name of the field in the data source.
String	dateFieldFormat()	The format for date fields in the data source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexFieldName()	The name of the index field to map to the data source field.
List<SdkField<?>>	sdkFields()
static Class<? extends DataSourceToIndexFieldMapping.Builder>	serializableBuilderClass()
DataSourceToIndexFieldMapping.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

dataSourceFieldName

public final String dataSourceFieldName()

The name of the field in the data source. You must first create the index field using the UpdateIndex API.

Returns:

The name of the field in the data source. You must first create the index field using the UpdateIndex API.

dateFieldFormat

public final String dateFieldFormat()

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

Returns:

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field, you must specify the date format. If the field is not a date field, an exception is thrown.

indexFieldName

public final String indexFieldName()

The name of the index field to map to the data source field. The index field type must match the data source field type.

Returns:

The name of the index field to map to the data source field. The index field type must match the data source field type.

toBuilder

public DataSourceToIndexFieldMapping.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataSourceToIndexFieldMapping.Builder,DataSourceToIndexFieldMapping>

builder

public static DataSourceToIndexFieldMapping.Builder builder()

serializableBuilderClass

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