/*
 * Copyright 2018-2023 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;

/**
 * <p>
 * Provides the configuration information for indexing Salesforce custom articles.
 * </p>
 * 
 * @see <a
 *      href="http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration"
 *      target="_top">AWS API Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SalesforceCustomKnowledgeArticleTypeConfiguration implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The name of the configuration.
     * </p>
     */
    private String name;
    /**
     * <p>
     * The name of the field in the custom knowledge article that contains the document data to index.
     * </p>
     */
    private String documentDataFieldName;
    /**
     * <p>
     * The name of the field in the custom knowledge article that contains the document title.
     * </p>
     */
    private String documentTitleFieldName;
    /**
     * <p>
     * Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create
     * custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information,
     * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
     * Salesforce data source field names must exist in your Salesforce custom metadata.
     * </p>
     */
    private java.util.List<DataSourceToIndexFieldMapping> fieldMappings;

    /**
     * <p>
     * The name of the configuration.
     * </p>
     * 
     * @param name
     *        The name of the configuration.
     */

    public void setName(String name) {
        this.name = name;
    }

    /**
     * <p>
     * The name of the configuration.
     * </p>
     * 
     * @return The name of the configuration.
     */

    public String getName() {
        return this.name;
    }

    /**
     * <p>
     * The name of the configuration.
     * </p>
     * 
     * @param name
     *        The name of the configuration.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SalesforceCustomKnowledgeArticleTypeConfiguration withName(String name) {
        setName(name);
        return this;
    }

    /**
     * <p>
     * The name of the field in the custom knowledge article that contains the document data to index.
     * </p>
     * 
     * @param documentDataFieldName
     *        The name of the field in the custom knowledge article that contains the document data to index.
     */

    public void setDocumentDataFieldName(String documentDataFieldName) {
        this.documentDataFieldName = documentDataFieldName;
    }

    /**
     * <p>
     * The name of the field in the custom knowledge article that contains the document data to index.
     * </p>
     * 
     * @return The name of the field in the custom knowledge article that contains the document data to index.
     */

    public String getDocumentDataFieldName() {
        return this.documentDataFieldName;
    }

    /**
     * <p>
     * The name of the field in the custom knowledge article that contains the document data to index.
     * </p>
     * 
     * @param documentDataFieldName
     *        The name of the field in the custom knowledge article that contains the document data to index.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SalesforceCustomKnowledgeArticleTypeConfiguration withDocumentDataFieldName(String documentDataFieldName) {
        setDocumentDataFieldName(documentDataFieldName);
        return this;
    }

    /**
     * <p>
     * The name of the field in the custom knowledge article that contains the document title.
     * </p>
     * 
     * @param documentTitleFieldName
     *        The name of the field in the custom knowledge article that contains the document title.
     */

    public void setDocumentTitleFieldName(String documentTitleFieldName) {
        this.documentTitleFieldName = documentTitleFieldName;
    }

    /**
     * <p>
     * The name of the field in the custom knowledge article that contains the document title.
     * </p>
     * 
     * @return The name of the field in the custom knowledge article that contains the document title.
     */

    public String getDocumentTitleFieldName() {
        return this.documentTitleFieldName;
    }

    /**
     * <p>
     * The name of the field in the custom knowledge article that contains the document title.
     * </p>
     * 
     * @param documentTitleFieldName
     *        The name of the field in the custom knowledge article that contains the document title.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SalesforceCustomKnowledgeArticleTypeConfiguration withDocumentTitleFieldName(String documentTitleFieldName) {
        setDocumentTitleFieldName(documentTitleFieldName);
        return this;
    }

    /**
     * <p>
     * Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create
     * custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information,
     * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
     * Salesforce data source field names must exist in your Salesforce custom metadata.
     * </p>
     * 
     * @return Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To
     *         create custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more
     *         information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data
     *         source fields</a>. The Salesforce data source field names must exist in your Salesforce custom metadata.
     */

    public java.util.List<DataSourceToIndexFieldMapping> getFieldMappings() {
        return fieldMappings;
    }

    /**
     * <p>
     * Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create
     * custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information,
     * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
     * Salesforce data source field names must exist in your Salesforce custom metadata.
     * </p>
     * 
     * @param fieldMappings
     *        Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To
     *        create custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more
     *        information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data
     *        source fields</a>. The Salesforce data source field names must exist in your Salesforce custom metadata.
     */

    public void setFieldMappings(java.util.Collection<DataSourceToIndexFieldMapping> fieldMappings) {
        if (fieldMappings == null) {
            this.fieldMappings = null;
            return;
        }

        this.fieldMappings = new java.util.ArrayList<DataSourceToIndexFieldMapping>(fieldMappings);
    }

    /**
     * <p>
     * Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create
     * custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information,
     * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
     * Salesforce data source field names must exist in your Salesforce custom metadata.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setFieldMappings(java.util.Collection)} or {@link #withFieldMappings(java.util.Collection)} if you want
     * to override the existing values.
     * </p>
     * 
     * @param fieldMappings
     *        Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To
     *        create custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more
     *        information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data
     *        source fields</a>. The Salesforce data source field names must exist in your Salesforce custom metadata.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SalesforceCustomKnowledgeArticleTypeConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings) {
        if (this.fieldMappings == null) {
            setFieldMappings(new java.util.ArrayList<DataSourceToIndexFieldMapping>(fieldMappings.length));
        }
        for (DataSourceToIndexFieldMapping ele : fieldMappings) {
            this.fieldMappings.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create
     * custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more information,
     * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The
     * Salesforce data source field names must exist in your Salesforce custom metadata.
     * </p>
     * 
     * @param fieldMappings
     *        Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To
     *        create custom fields, use the <code>UpdateIndex</code> API before you map to Salesforce fields. For more
     *        information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data
     *        source fields</a>. The Salesforce data source field names must exist in your Salesforce custom metadata.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SalesforceCustomKnowledgeArticleTypeConfiguration withFieldMappings(java.util.Collection<DataSourceToIndexFieldMapping> fieldMappings) {
        setFieldMappings(fieldMappings);
        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 (getName() != null)
            sb.append("Name: ").append(getName()).append(",");
        if (getDocumentDataFieldName() != null)
            sb.append("DocumentDataFieldName: ").append(getDocumentDataFieldName()).append(",");
        if (getDocumentTitleFieldName() != null)
            sb.append("DocumentTitleFieldName: ").append(getDocumentTitleFieldName()).append(",");
        if (getFieldMappings() != null)
            sb.append("FieldMappings: ").append(getFieldMappings());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof SalesforceCustomKnowledgeArticleTypeConfiguration == false)
            return false;
        SalesforceCustomKnowledgeArticleTypeConfiguration other = (SalesforceCustomKnowledgeArticleTypeConfiguration) obj;
        if (other.getName() == null ^ this.getName() == null)
            return false;
        if (other.getName() != null && other.getName().equals(this.getName()) == false)
            return false;
        if (other.getDocumentDataFieldName() == null ^ this.getDocumentDataFieldName() == null)
            return false;
        if (other.getDocumentDataFieldName() != null && other.getDocumentDataFieldName().equals(this.getDocumentDataFieldName()) == false)
            return false;
        if (other.getDocumentTitleFieldName() == null ^ this.getDocumentTitleFieldName() == null)
            return false;
        if (other.getDocumentTitleFieldName() != null && other.getDocumentTitleFieldName().equals(this.getDocumentTitleFieldName()) == false)
            return false;
        if (other.getFieldMappings() == null ^ this.getFieldMappings() == null)
            return false;
        if (other.getFieldMappings() != null && other.getFieldMappings().equals(this.getFieldMappings()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
        hashCode = prime * hashCode + ((getDocumentDataFieldName() == null) ? 0 : getDocumentDataFieldName().hashCode());
        hashCode = prime * hashCode + ((getDocumentTitleFieldName() == null) ? 0 : getDocumentTitleFieldName().hashCode());
        hashCode = prime * hashCode + ((getFieldMappings() == null) ? 0 : getFieldMappings().hashCode());
        return hashCode;
    }

    @Override
    public SalesforceCustomKnowledgeArticleTypeConfiguration clone() {
        try {
            return (SalesforceCustomKnowledgeArticleTypeConfiguration) 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.SalesforceCustomKnowledgeArticleTypeConfigurationMarshaller.getInstance().marshall(this,
                protocolMarshaller);
    }
}
