com.amazonaws.services.textract.model.GetDocumentTextDetectionResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-textract Show documentation
/*
* 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.textract.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetDocumentTextDetectionResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Information about a document that Amazon Textract processed. DocumentMetadata is returned in every
* page of paginated responses from an Amazon Textract video operation.
*
*/
private DocumentMetadata documentMetadata;
/**
*
* The current status of the text detection job.
*
*/
private String jobStatus;
/**
*
* If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent
* request to retrieve the next set of text-detection results.
*
*/
private String nextToken;
/**
*
* The results of the text-detection operation.
*
*/
private java.util.List blocks;
/**
*
* A list of warnings that occurred during the text-detection operation for the document.
*
*/
private java.util.List warnings;
/**
*
* Returns if the detection job could not be completed. Contains explanation for what error occured.
*
*/
private String statusMessage;
/** */
private String detectDocumentTextModelVersion;
/**
*
* Information about a document that Amazon Textract processed. DocumentMetadata is returned in every
* page of paginated responses from an Amazon Textract video operation.
*
*
* @param documentMetadata
* Information about a document that Amazon Textract processed. DocumentMetadata is returned in
* every page of paginated responses from an Amazon Textract video operation.
*/
public void setDocumentMetadata(DocumentMetadata documentMetadata) {
this.documentMetadata = documentMetadata;
}
/**
*
* Information about a document that Amazon Textract processed. DocumentMetadata is returned in every
* page of paginated responses from an Amazon Textract video operation.
*
*
* @return Information about a document that Amazon Textract processed. DocumentMetadata is returned in
* every page of paginated responses from an Amazon Textract video operation.
*/
public DocumentMetadata getDocumentMetadata() {
return this.documentMetadata;
}
/**
*
* Information about a document that Amazon Textract processed. DocumentMetadata is returned in every
* page of paginated responses from an Amazon Textract video operation.
*
*
* @param documentMetadata
* Information about a document that Amazon Textract processed. DocumentMetadata is returned in
* every page of paginated responses from an Amazon Textract video operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionResult withDocumentMetadata(DocumentMetadata documentMetadata) {
setDocumentMetadata(documentMetadata);
return this;
}
/**
*
* The current status of the text detection job.
*
*
* @param jobStatus
* The current status of the text detection job.
* @see JobStatus
*/
public void setJobStatus(String jobStatus) {
this.jobStatus = jobStatus;
}
/**
*
* The current status of the text detection job.
*
*
* @return The current status of the text detection job.
* @see JobStatus
*/
public String getJobStatus() {
return this.jobStatus;
}
/**
*
* The current status of the text detection job.
*
*
* @param jobStatus
* The current status of the text detection job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public GetDocumentTextDetectionResult withJobStatus(String jobStatus) {
setJobStatus(jobStatus);
return this;
}
/**
*
* The current status of the text detection job.
*
*
* @param jobStatus
* The current status of the text detection job.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public GetDocumentTextDetectionResult withJobStatus(JobStatus jobStatus) {
this.jobStatus = jobStatus.toString();
return this;
}
/**
*
* If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent
* request to retrieve the next set of text-detection results.
*
*
* @param nextToken
* If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent
* request to retrieve the next set of text-detection results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent
* request to retrieve the next set of text-detection results.
*
*
* @return If the response is truncated, Amazon Textract returns this token. You can use this token in the
* subsequent request to retrieve the next set of text-detection results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent
* request to retrieve the next set of text-detection results.
*
*
* @param nextToken
* If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent
* request to retrieve the next set of text-detection results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionResult withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The results of the text-detection operation.
*
*
* @return The results of the text-detection operation.
*/
public java.util.List getBlocks() {
return blocks;
}
/**
*
* The results of the text-detection operation.
*
*
* @param blocks
* The results of the text-detection operation.
*/
public void setBlocks(java.util.Collection blocks) {
if (blocks == null) {
this.blocks = null;
return;
}
this.blocks = new java.util.ArrayList(blocks);
}
/**
*
* The results of the text-detection operation.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setBlocks(java.util.Collection)} or {@link #withBlocks(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param blocks
* The results of the text-detection operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionResult withBlocks(Block... blocks) {
if (this.blocks == null) {
setBlocks(new java.util.ArrayList(blocks.length));
}
for (Block ele : blocks) {
this.blocks.add(ele);
}
return this;
}
/**
*
* The results of the text-detection operation.
*
*
* @param blocks
* The results of the text-detection operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionResult withBlocks(java.util.Collection blocks) {
setBlocks(blocks);
return this;
}
/**
*
* A list of warnings that occurred during the text-detection operation for the document.
*
*
* @return A list of warnings that occurred during the text-detection operation for the document.
*/
public java.util.List getWarnings() {
return warnings;
}
/**
*
* A list of warnings that occurred during the text-detection operation for the document.
*
*
* @param warnings
* A list of warnings that occurred during the text-detection operation for the document.
*/
public void setWarnings(java.util.Collection warnings) {
if (warnings == null) {
this.warnings = null;
return;
}
this.warnings = new java.util.ArrayList(warnings);
}
/**
*
* A list of warnings that occurred during the text-detection operation for the document.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setWarnings(java.util.Collection)} or {@link #withWarnings(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param warnings
* A list of warnings that occurred during the text-detection operation for the document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionResult withWarnings(Warning... warnings) {
if (this.warnings == null) {
setWarnings(new java.util.ArrayList(warnings.length));
}
for (Warning ele : warnings) {
this.warnings.add(ele);
}
return this;
}
/**
*
* A list of warnings that occurred during the text-detection operation for the document.
*
*
* @param warnings
* A list of warnings that occurred during the text-detection operation for the document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionResult withWarnings(java.util.Collection warnings) {
setWarnings(warnings);
return this;
}
/**
*
* Returns if the detection job could not be completed. Contains explanation for what error occured.
*
*
* @param statusMessage
* Returns if the detection job could not be completed. Contains explanation for what error occured.
*/
public void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
/**
*
* Returns if the detection job could not be completed. Contains explanation for what error occured.
*
*
* @return Returns if the detection job could not be completed. Contains explanation for what error occured.
*/
public String getStatusMessage() {
return this.statusMessage;
}
/**
*
* Returns if the detection job could not be completed. Contains explanation for what error occured.
*
*
* @param statusMessage
* Returns if the detection job could not be completed. Contains explanation for what error occured.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionResult withStatusMessage(String statusMessage) {
setStatusMessage(statusMessage);
return this;
}
/**
*
*
* @param detectDocumentTextModelVersion
*/
public void setDetectDocumentTextModelVersion(String detectDocumentTextModelVersion) {
this.detectDocumentTextModelVersion = detectDocumentTextModelVersion;
}
/**
*
*
* @return
*/
public String getDetectDocumentTextModelVersion() {
return this.detectDocumentTextModelVersion;
}
/**
*
*
* @param detectDocumentTextModelVersion
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentTextDetectionResult withDetectDocumentTextModelVersion(String detectDocumentTextModelVersion) {
setDetectDocumentTextModelVersion(detectDocumentTextModelVersion);
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 (getDocumentMetadata() != null)
sb.append("DocumentMetadata: ").append(getDocumentMetadata()).append(",");
if (getJobStatus() != null)
sb.append("JobStatus: ").append(getJobStatus()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getBlocks() != null)
sb.append("Blocks: ").append(getBlocks()).append(",");
if (getWarnings() != null)
sb.append("Warnings: ").append(getWarnings()).append(",");
if (getStatusMessage() != null)
sb.append("StatusMessage: ").append(getStatusMessage()).append(",");
if (getDetectDocumentTextModelVersion() != null)
sb.append("DetectDocumentTextModelVersion: ").append(getDetectDocumentTextModelVersion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetDocumentTextDetectionResult == false)
return false;
GetDocumentTextDetectionResult other = (GetDocumentTextDetectionResult) obj;
if (other.getDocumentMetadata() == null ^ this.getDocumentMetadata() == null)
return false;
if (other.getDocumentMetadata() != null && other.getDocumentMetadata().equals(this.getDocumentMetadata()) == false)
return false;
if (other.getJobStatus() == null ^ this.getJobStatus() == null)
return false;
if (other.getJobStatus() != null && other.getJobStatus().equals(this.getJobStatus()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getBlocks() == null ^ this.getBlocks() == null)
return false;
if (other.getBlocks() != null && other.getBlocks().equals(this.getBlocks()) == false)
return false;
if (other.getWarnings() == null ^ this.getWarnings() == null)
return false;
if (other.getWarnings() != null && other.getWarnings().equals(this.getWarnings()) == false)
return false;
if (other.getStatusMessage() == null ^ this.getStatusMessage() == null)
return false;
if (other.getStatusMessage() != null && other.getStatusMessage().equals(this.getStatusMessage()) == false)
return false;
if (other.getDetectDocumentTextModelVersion() == null ^ this.getDetectDocumentTextModelVersion() == null)
return false;
if (other.getDetectDocumentTextModelVersion() != null
&& other.getDetectDocumentTextModelVersion().equals(this.getDetectDocumentTextModelVersion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDocumentMetadata() == null) ? 0 : getDocumentMetadata().hashCode());
hashCode = prime * hashCode + ((getJobStatus() == null) ? 0 : getJobStatus().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getBlocks() == null) ? 0 : getBlocks().hashCode());
hashCode = prime * hashCode + ((getWarnings() == null) ? 0 : getWarnings().hashCode());
hashCode = prime * hashCode + ((getStatusMessage() == null) ? 0 : getStatusMessage().hashCode());
hashCode = prime * hashCode + ((getDetectDocumentTextModelVersion() == null) ? 0 : getDetectDocumentTextModelVersion().hashCode());
return hashCode;
}
@Override
public GetDocumentTextDetectionResult clone() {
try {
return (GetDocumentTextDetectionResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}