com.amazonaws.services.kendra.model

Class DataSourceToIndexFieldMapping

java.lang.Object

com.amazonaws.services.kendra.model.DataSourceToIndexFieldMapping

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DataSourceToIndexFieldMapping
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSourceToIndexFieldMapping()

Method Summary

Modifier and Type	Method and Description
DataSourceToIndexFieldMapping	clone()
boolean	equals(Object obj)
String	getDataSourceFieldName() The name of the field in the data source.
String	getDateFieldFormat() The format for date fields in the data source.
String	getIndexFieldName() The name of the index field to map to the data source field.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDataSourceFieldName(String dataSourceFieldName) The name of the field in the data source.
void	setDateFieldFormat(String dateFieldFormat) The format for date fields in the data source.
void	setIndexFieldName(String indexFieldName) The name of the index field to map to the data source field.
String	toString() Returns a string representation of this object.
DataSourceToIndexFieldMapping	withDataSourceFieldName(String dataSourceFieldName) The name of the field in the data source.
DataSourceToIndexFieldMapping	withDateFieldFormat(String dateFieldFormat) The format for date fields in the data source.
DataSourceToIndexFieldMapping	withIndexFieldName(String indexFieldName) The name of the index field to map to the data source field.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataSourceToIndexFieldMapping

public DataSourceToIndexFieldMapping()

Method Detail

setDataSourceFieldName

public void setDataSourceFieldName(String dataSourceFieldName)

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

Parameters:

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

getDataSourceFieldName

public String getDataSourceFieldName()

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.

withDataSourceFieldName

public DataSourceToIndexFieldMapping withDataSourceFieldName(String dataSourceFieldName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDateFieldFormat

public void setDateFieldFormat(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.

Parameters:

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.

getDateFieldFormat

public String getDateFieldFormat()

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.

withDateFieldFormat

public DataSourceToIndexFieldMapping withDateFieldFormat(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setIndexFieldName

public void setIndexFieldName(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.

Parameters:

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.

getIndexFieldName

public String getIndexFieldName()

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.

withIndexFieldName

public DataSourceToIndexFieldMapping withIndexFieldName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DataSourceToIndexFieldMapping clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.