com.amazonaws.services.comprehend.model.ClassifyDocumentResult Maven / Gradle / Ivy
/*
* 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ClassifyDocumentResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The classes used by the document being analyzed. These are used for multi-class trained models. Individual
* classes are mutually exclusive and each document is expected to have only a single class assigned to it. For
* example, an animal can be a dog or a cat, but not both at the same time.
*
*/
private java.util.List classes;
/**
*
* The labels used the document being analyzed. These are used for multi-label trained models. Individual labels
* represent different categories that are related in some manner and are not mutually exclusive. For example, a
* movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at
* the same time.
*
*/
private java.util.List labels;
/**
*
* The classes used by the document being analyzed. These are used for multi-class trained models. Individual
* classes are mutually exclusive and each document is expected to have only a single class assigned to it. For
* example, an animal can be a dog or a cat, but not both at the same time.
*
*
* @return The classes used by the document being analyzed. These are used for multi-class trained models.
* Individual classes are mutually exclusive and each document is expected to have only a single class
* assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.
*/
public java.util.List getClasses() {
return classes;
}
/**
*
* The classes used by the document being analyzed. These are used for multi-class trained models. Individual
* classes are mutually exclusive and each document is expected to have only a single class assigned to it. For
* example, an animal can be a dog or a cat, but not both at the same time.
*
*
* @param classes
* The classes used by the document being analyzed. These are used for multi-class trained models. Individual
* classes are mutually exclusive and each document is expected to have only a single class assigned to it.
* For example, an animal can be a dog or a cat, but not both at the same time.
*/
public void setClasses(java.util.Collection classes) {
if (classes == null) {
this.classes = null;
return;
}
this.classes = new java.util.ArrayList(classes);
}
/**
*
* The classes used by the document being analyzed. These are used for multi-class trained models. Individual
* classes are mutually exclusive and each document is expected to have only a single class assigned to it. For
* example, an animal can be a dog or a cat, but not both at the same time.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setClasses(java.util.Collection)} or {@link #withClasses(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param classes
* The classes used by the document being analyzed. These are used for multi-class trained models. Individual
* classes are mutually exclusive and each document is expected to have only a single class assigned to it.
* For example, an animal can be a dog or a cat, but not both at the same time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClassifyDocumentResult withClasses(DocumentClass... classes) {
if (this.classes == null) {
setClasses(new java.util.ArrayList(classes.length));
}
for (DocumentClass ele : classes) {
this.classes.add(ele);
}
return this;
}
/**
*
* The classes used by the document being analyzed. These are used for multi-class trained models. Individual
* classes are mutually exclusive and each document is expected to have only a single class assigned to it. For
* example, an animal can be a dog or a cat, but not both at the same time.
*
*
* @param classes
* The classes used by the document being analyzed. These are used for multi-class trained models. Individual
* classes are mutually exclusive and each document is expected to have only a single class assigned to it.
* For example, an animal can be a dog or a cat, but not both at the same time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClassifyDocumentResult withClasses(java.util.Collection classes) {
setClasses(classes);
return this;
}
/**
*
* The labels used the document being analyzed. These are used for multi-label trained models. Individual labels
* represent different categories that are related in some manner and are not mutually exclusive. For example, a
* movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at
* the same time.
*
*
* @return The labels used the document being analyzed. These are used for multi-label trained models. Individual
* labels represent different categories that are related in some manner and are not mutually exclusive. For
* example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and
* a comedy, all at the same time.
*/
public java.util.List getLabels() {
return labels;
}
/**
*
* The labels used the document being analyzed. These are used for multi-label trained models. Individual labels
* represent different categories that are related in some manner and are not mutually exclusive. For example, a
* movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at
* the same time.
*
*
* @param labels
* The labels used the document being analyzed. These are used for multi-label trained models. Individual
* labels represent different categories that are related in some manner and are not mutually exclusive. For
* example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a
* comedy, all at the same time.
*/
public void setLabels(java.util.Collection labels) {
if (labels == null) {
this.labels = null;
return;
}
this.labels = new java.util.ArrayList(labels);
}
/**
*
* The labels used the document being analyzed. These are used for multi-label trained models. Individual labels
* represent different categories that are related in some manner and are not mutually exclusive. For example, a
* movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at
* the same time.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLabels(java.util.Collection)} or {@link #withLabels(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param labels
* The labels used the document being analyzed. These are used for multi-label trained models. Individual
* labels represent different categories that are related in some manner and are not mutually exclusive. For
* example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a
* comedy, all at the same time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClassifyDocumentResult withLabels(DocumentLabel... labels) {
if (this.labels == null) {
setLabels(new java.util.ArrayList(labels.length));
}
for (DocumentLabel ele : labels) {
this.labels.add(ele);
}
return this;
}
/**
*
* The labels used the document being analyzed. These are used for multi-label trained models. Individual labels
* represent different categories that are related in some manner and are not mutually exclusive. For example, a
* movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at
* the same time.
*
*
* @param labels
* The labels used the document being analyzed. These are used for multi-label trained models. Individual
* labels represent different categories that are related in some manner and are not mutually exclusive. For
* example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a
* comedy, all at the same time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClassifyDocumentResult withLabels(java.util.Collection labels) {
setLabels(labels);
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 (getClasses() != null)
sb.append("Classes: ").append(getClasses()).append(",");
if (getLabels() != null)
sb.append("Labels: ").append(getLabels());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ClassifyDocumentResult == false)
return false;
ClassifyDocumentResult other = (ClassifyDocumentResult) obj;
if (other.getClasses() == null ^ this.getClasses() == null)
return false;
if (other.getClasses() != null && other.getClasses().equals(this.getClasses()) == false)
return false;
if (other.getLabels() == null ^ this.getLabels() == null)
return false;
if (other.getLabels() != null && other.getLabels().equals(this.getLabels()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClasses() == null) ? 0 : getClasses().hashCode());
hashCode = prime * hashCode + ((getLabels() == null) ? 0 : getLabels().hashCode());
return hashCode;
}
@Override
public ClassifyDocumentResult clone() {
try {
return (ClassifyDocumentResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}