com.amazonaws.services.kendra.model.DataSourceToIndexFieldMapping Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DataSourceToIndexFieldMapping implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the field in the data source. You must first create the index field using the
* UpdateIndex API.
*
*/
private String dataSourceFieldName;
/**
*
* 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.
*
*/
private String dateFieldFormat;
/**
*
* The name of the index field to map to the data source field. The index field type must match the data source
* field type.
*
*/
private String indexFieldName;
/**
*
* The name of the field in the data source. You must first create the index field using the
* UpdateIndex API.
*
*
* @param dataSourceFieldName
* The name of the field in the data source. You must first create the index field using the
* UpdateIndex API.
*/
public void setDataSourceFieldName(String dataSourceFieldName) {
this.dataSourceFieldName = dataSourceFieldName;
}
/**
*
* The name of the field in the data source. You must first create the index field using the
* UpdateIndex API.
*
*
* @return The name of the field in the data source. You must first create the index field using the
* UpdateIndex API.
*/
public String getDataSourceFieldName() {
return this.dataSourceFieldName;
}
/**
*
* The name of the field in the data source. You must first create the index field using the
* UpdateIndex API.
*
*
* @param dataSourceFieldName
* The name of the field in the data source. You must first create the index field using the
* UpdateIndex API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataSourceToIndexFieldMapping withDataSourceFieldName(String dataSourceFieldName) {
setDataSourceFieldName(dataSourceFieldName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setDateFieldFormat(String dateFieldFormat) {
this.dateFieldFormat = 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.
*
*
* @return 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.
*/
public String getDateFieldFormat() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataSourceToIndexFieldMapping withDateFieldFormat(String dateFieldFormat) {
setDateFieldFormat(dateFieldFormat);
return this;
}
/**
*
* The name of the index field to map to the data source field. The index field type must match the data source
* field type.
*
*
* @param 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.
*/
public void setIndexFieldName(String indexFieldName) {
this.indexFieldName = 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.
*
*
* @return The name of the index field to map to the data source field. The index field type must match the data
* source field type.
*/
public String getIndexFieldName() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataSourceToIndexFieldMapping withIndexFieldName(String indexFieldName) {
setIndexFieldName(indexFieldName);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDataSourceFieldName() != null)
sb.append("DataSourceFieldName: ").append(getDataSourceFieldName()).append(",");
if (getDateFieldFormat() != null)
sb.append("DateFieldFormat: ").append(getDateFieldFormat()).append(",");
if (getIndexFieldName() != null)
sb.append("IndexFieldName: ").append(getIndexFieldName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DataSourceToIndexFieldMapping == false)
return false;
DataSourceToIndexFieldMapping other = (DataSourceToIndexFieldMapping) obj;
if (other.getDataSourceFieldName() == null ^ this.getDataSourceFieldName() == null)
return false;
if (other.getDataSourceFieldName() != null && other.getDataSourceFieldName().equals(this.getDataSourceFieldName()) == false)
return false;
if (other.getDateFieldFormat() == null ^ this.getDateFieldFormat() == null)
return false;
if (other.getDateFieldFormat() != null && other.getDateFieldFormat().equals(this.getDateFieldFormat()) == false)
return false;
if (other.getIndexFieldName() == null ^ this.getIndexFieldName() == null)
return false;
if (other.getIndexFieldName() != null && other.getIndexFieldName().equals(this.getIndexFieldName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDataSourceFieldName() == null) ? 0 : getDataSourceFieldName().hashCode());
hashCode = prime * hashCode + ((getDateFieldFormat() == null) ? 0 : getDateFieldFormat().hashCode());
hashCode = prime * hashCode + ((getIndexFieldName() == null) ? 0 : getIndexFieldName().hashCode());
return hashCode;
}
@Override
public DataSourceToIndexFieldMapping clone() {
try {
return (DataSourceToIndexFieldMapping) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kendra.model.transform.DataSourceToIndexFieldMappingMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}