• Home
• com.amazonaws
• aws-java-sdk-kendra
• 1.12.756
• source code
• DocumentRelevanceConfiguration.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.kendra.model.DocumentRelevanceConfiguration Maven / Gradle / Ivy

/*
 * 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;

/**
 * 

 * Overrides the document relevance properties of a custom index field.
 * 
 * 
 * @see AWS API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DocumentRelevanceConfiguration implements Serializable, Cloneable, StructuredPojo {

    /**
     * 

     * The name of the index field.
     * 
     */
    private String name;
    /**
     * 

     * Provides information for tuning the relevance of a field in a search. When a query includes terms that match the
     * field, the results are given a boost in the response based on these tuning parameters.
     * 
     */
    private Relevance relevance;

    /**
     * 

     * The name of the index field.
     * 
     * 
     * @param name
     *        The name of the index field.
     */

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

    /**
     * 

     * The name of the index field.
     * 
     * 
     * @return The name of the index field.
     */

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

    /**
     * 

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

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

    /**
     * 

     * Provides information for tuning the relevance of a field in a search. When a query includes terms that match the
     * field, the results are given a boost in the response based on these tuning parameters.
     * 
     * 
     * @param relevance
     *        Provides information for tuning the relevance of a field in a search. When a query includes terms that
     *        match the field, the results are given a boost in the response based on these tuning parameters.
     */

    public void setRelevance(Relevance relevance) {
        this.relevance = relevance;
    }

    /**
     * 

     * Provides information for tuning the relevance of a field in a search. When a query includes terms that match the
     * field, the results are given a boost in the response based on these tuning parameters.
     * 
     * 
     * @return Provides information for tuning the relevance of a field in a search. When a query includes terms that
     *         match the field, the results are given a boost in the response based on these tuning parameters.
     */

    public Relevance getRelevance() {
        return this.relevance;
    }

    /**
     * 

     * Provides information for tuning the relevance of a field in a search. When a query includes terms that match the
     * field, the results are given a boost in the response based on these tuning parameters.
     * 
     * 
     * @param relevance
     *        Provides information for tuning the relevance of a field in a search. When a query includes terms that
     *        match the field, the results are given a boost in the response based on these tuning parameters.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DocumentRelevanceConfiguration withRelevance(Relevance relevance) {
        setRelevance(relevance);
        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 (getRelevance() != null)
            sb.append("Relevance: ").append(getRelevance());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof DocumentRelevanceConfiguration == false)
            return false;
        DocumentRelevanceConfiguration other = (DocumentRelevanceConfiguration) obj;
        if (other.getName() == null ^ this.getName() == null)
            return false;
        if (other.getName() != null && other.getName().equals(this.getName()) == false)
            return false;
        if (other.getRelevance() == null ^ this.getRelevance() == null)
            return false;
        if (other.getRelevance() != null && other.getRelevance().equals(this.getRelevance()) == 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 + ((getRelevance() == null) ? 0 : getRelevance().hashCode());
        return hashCode;
    }

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