com.amazonaws.services.comprehend.model.DocumentLabel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-comprehend Show documentation
The AWS Java SDK for Amazon Comprehend module holds the client classes that are used for communicating with Amazon Comprehend Service
There is a newer version: 1.12.772
Show newest version
/*
 * Copyright 2017-2022 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.comprehend.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * Specifies one of the label or labels that categorize the document being analyzed.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DocumentLabel implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The name of the label.
     * 
     */
    private String name;
    /**
     * 
     * The confidence score that Amazon Comprehend has this label correctly attributed.
     * 
     */
    private Float score;

    /**
     * 
     * The name of the label.
     * 
     * 
     * @param name
     *        The name of the label.
     */

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

    /**
     * 
     * The name of the label.
     * 
     * 
     * @return The name of the label.
     */

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

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

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

    /**
     * 
     * The confidence score that Amazon Comprehend has this label correctly attributed.
     * 
     * 
     * @param score
     *        The confidence score that Amazon Comprehend has this label correctly attributed.
     */

    public void setScore(Float score) {
        this.score = score;
    }

    /**
     * 
     * The confidence score that Amazon Comprehend has this label correctly attributed.
     * 
     * 
     * @return The confidence score that Amazon Comprehend has this label correctly attributed.
     */

    public Float getScore() {
        return this.score;
    }

    /**
     * 
     * The confidence score that Amazon Comprehend has this label correctly attributed.
     * 
     * 
     * @param score
     *        The confidence score that Amazon Comprehend has this label correctly attributed.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DocumentLabel withScore(Float score) {
        setScore(score);
        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 (getScore() != null)
            sb.append("Score: ").append(getScore());
        sb.append("}");
        return sb.toString();
    }

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

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

    @Override
    public DocumentLabel clone() {
        try {
            return (DocumentLabel) 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.comprehend.model.transform.DocumentLabelMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}