com.amazonaws.services.comprehend.model.DocumentClass 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
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
/*
* 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.comprehend.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies the class that categorizes the document being analyzed
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DocumentClass implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the class.
*
*/
private String name;
/**
*
* The confidence score that Amazon Comprehend has this class correctly attributed.
*
*/
private Float score;
/**
*
* Page number in the input document. This field is present in the response only if your request includes the
* Byte parameter.
*
*/
private Integer page;
/**
*
* The name of the class.
*
*
* @param name
* The name of the class.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the class.
*
*
* @return The name of the class.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the class.
*
*
* @param name
* The name of the class.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentClass withName(String name) {
setName(name);
return this;
}
/**
*
* The confidence score that Amazon Comprehend has this class correctly attributed.
*
*
* @param score
* The confidence score that Amazon Comprehend has this class correctly attributed.
*/
public void setScore(Float score) {
this.score = score;
}
/**
*
* The confidence score that Amazon Comprehend has this class correctly attributed.
*
*
* @return The confidence score that Amazon Comprehend has this class correctly attributed.
*/
public Float getScore() {
return this.score;
}
/**
*
* The confidence score that Amazon Comprehend has this class correctly attributed.
*
*
* @param score
* The confidence score that Amazon Comprehend has this class correctly attributed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentClass withScore(Float score) {
setScore(score);
return this;
}
/**
*
* Page number in the input document. This field is present in the response only if your request includes the
* Byte parameter.
*
*
* @param page
* Page number in the input document. This field is present in the response only if your request includes the
* Byte parameter.
*/
public void setPage(Integer page) {
this.page = page;
}
/**
*
* Page number in the input document. This field is present in the response only if your request includes the
* Byte parameter.
*
*
* @return Page number in the input document. This field is present in the response only if your request includes
* the Byte parameter.
*/
public Integer getPage() {
return this.page;
}
/**
*
* Page number in the input document. This field is present in the response only if your request includes the
* Byte parameter.
*
*
* @param page
* Page number in the input document. This field is present in the response only if your request includes the
* Byte parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentClass withPage(Integer page) {
setPage(page);
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()).append(",");
if (getPage() != null)
sb.append("Page: ").append(getPage());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DocumentClass == false)
return false;
DocumentClass other = (DocumentClass) 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;
if (other.getPage() == null ^ this.getPage() == null)
return false;
if (other.getPage() != null && other.getPage().equals(this.getPage()) == 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());
hashCode = prime * hashCode + ((getPage() == null) ? 0 : getPage().hashCode());
return hashCode;
}
@Override
public DocumentClass clone() {
try {
return (DocumentClass) 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.DocumentClassMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}