/*
 * 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>
 * A featured document with its metadata information. This document is displayed at the top of the search results page,
 * placed above all other results for certain queries. If there's an exact match of a query, then the document is
 * featured in the search results.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedDocumentWithMetadata"
 *      target="_top">AWS API Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class FeaturedDocumentWithMetadata implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The identifier of the featured document with its metadata. You can use the <a
     * href="https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html">Query</a> API to search for specific documents
     * with their document IDs included in the result items, or you can use the console.
     * </p>
     */
    private String id;
    /**
     * <p>
     * The main title of the featured document.
     * </p>
     */
    private String title;
    /**
     * <p>
     * The source URI location of the featured document.
     * </p>
     */
    private String uRI;

    /**
     * <p>
     * The identifier of the featured document with its metadata. You can use the <a
     * href="https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html">Query</a> API to search for specific documents
     * with their document IDs included in the result items, or you can use the console.
     * </p>
     * 
     * @param id
     *        The identifier of the featured document with its metadata. You can use the <a
     *        href="https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html">Query</a> API to search for specific
     *        documents with their document IDs included in the result items, or you can use the console.
     */

    public void setId(String id) {
        this.id = id;
    }

    /**
     * <p>
     * The identifier of the featured document with its metadata. You can use the <a
     * href="https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html">Query</a> API to search for specific documents
     * with their document IDs included in the result items, or you can use the console.
     * </p>
     * 
     * @return The identifier of the featured document with its metadata. You can use the <a
     *         href="https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html">Query</a> API to search for specific
     *         documents with their document IDs included in the result items, or you can use the console.
     */

    public String getId() {
        return this.id;
    }

    /**
     * <p>
     * The identifier of the featured document with its metadata. You can use the <a
     * href="https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html">Query</a> API to search for specific documents
     * with their document IDs included in the result items, or you can use the console.
     * </p>
     * 
     * @param id
     *        The identifier of the featured document with its metadata. You can use the <a
     *        href="https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html">Query</a> API to search for specific
     *        documents with their document IDs included in the result items, or you can use the console.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public FeaturedDocumentWithMetadata withId(String id) {
        setId(id);
        return this;
    }

    /**
     * <p>
     * The main title of the featured document.
     * </p>
     * 
     * @param title
     *        The main title of the featured document.
     */

    public void setTitle(String title) {
        this.title = title;
    }

    /**
     * <p>
     * The main title of the featured document.
     * </p>
     * 
     * @return The main title of the featured document.
     */

    public String getTitle() {
        return this.title;
    }

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

    public FeaturedDocumentWithMetadata withTitle(String title) {
        setTitle(title);
        return this;
    }

    /**
     * <p>
     * The source URI location of the featured document.
     * </p>
     * 
     * @param uRI
     *        The source URI location of the featured document.
     */

    public void setURI(String uRI) {
        this.uRI = uRI;
    }

    /**
     * <p>
     * The source URI location of the featured document.
     * </p>
     * 
     * @return The source URI location of the featured document.
     */

    public String getURI() {
        return this.uRI;
    }

    /**
     * <p>
     * The source URI location of the featured document.
     * </p>
     * 
     * @param uRI
     *        The source URI location of the featured document.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public FeaturedDocumentWithMetadata withURI(String uRI) {
        setURI(uRI);
        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 (getId() != null)
            sb.append("Id: ").append(getId()).append(",");
        if (getTitle() != null)
            sb.append("Title: ").append(getTitle()).append(",");
        if (getURI() != null)
            sb.append("URI: ").append(getURI());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof FeaturedDocumentWithMetadata == false)
            return false;
        FeaturedDocumentWithMetadata other = (FeaturedDocumentWithMetadata) obj;
        if (other.getId() == null ^ this.getId() == null)
            return false;
        if (other.getId() != null && other.getId().equals(this.getId()) == false)
            return false;
        if (other.getTitle() == null ^ this.getTitle() == null)
            return false;
        if (other.getTitle() != null && other.getTitle().equals(this.getTitle()) == false)
            return false;
        if (other.getURI() == null ^ this.getURI() == null)
            return false;
        if (other.getURI() != null && other.getURI().equals(this.getURI()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
        hashCode = prime * hashCode + ((getTitle() == null) ? 0 : getTitle().hashCode());
        hashCode = prime * hashCode + ((getURI() == null) ? 0 : getURI().hashCode());
        return hashCode;
    }

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