/* * Copyright 2010-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.textract.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *
* Gets the results for an Amazon Textract asynchronous operation that detects * text in a document. Amazon Textract can detect lines of text and the words * that make up a line of text. *
*
* You start asynchronous text detection by calling
* StartDocumentTextDetection, which returns a job identifier (
* JobId
). When the text detection operation finishes, Amazon
* Textract publishes a completion status to the Amazon Simple Notification
* Service (Amazon SNS) topic that's registered in the initial call to
* StartDocumentTextDetection
. To get the results of the
* text-detection operation, first check that the status value published to the
* Amazon SNS topic is SUCCEEDED
. If so, call
* GetDocumentTextDetection
, and pass the job identifier (
* JobId
) from the initial call to
* StartDocumentTextDetection
.
*
* GetDocumentTextDetection
returns an array of Block
* objects.
*
* Each document page has as an associated Block
of type PAGE. Each
* PAGE Block
object is the parent of LINE Block
* objects that represent the lines of detected text on a page. A LINE
* Block
object is a parent for each word that makes up the line.
* Words are represented by Block
objects of type WORD.
*
* Use the MaxResults parameter to limit the number of blocks that are returned.
* If there are more results than specified in MaxResults
, the
* value of NextToken
in the operation response contains a
* pagination token for getting the next set of results. To get the next page of
* results, call GetDocumentTextDetection
, and populate the
* NextToken
request parameter with the token value that's returned
* from the previous call to GetDocumentTextDetection
.
*
* For more information, see Document Text Detection. *
*/ public class GetDocumentTextDetectionRequest extends AmazonWebServiceRequest implements Serializable { /** *
* A unique identifier for the text detection job. The JobId
is
* returned from StartDocumentTextDetection
. A
* JobId
value is only valid for 7 days.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*/
private String jobId;
/**
*
* The maximum number of results to return per paginated call. The largest * value you can specify is 1,000. If you specify a value greater than * 1,000, a maximum of 1,000 results is returned. The default value is * 1,000. *
*
* Constraints:
* Range: 1 -
*/
private Integer maxResults;
/**
*
* If the previous response was incomplete (because there are more blocks to * retrieve), Amazon Textract returns a pagination token in the response. * You can use this pagination token to retrieve the next set of blocks. *
*
* Constraints:
* Length: 1 - 255
* Pattern: .*\S.*
*/
private String nextToken;
/**
*
* A unique identifier for the text detection job. The JobId
is
* returned from StartDocumentTextDetection
. A
* JobId
value is only valid for 7 days.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @return
* A unique identifier for the text detection job. The
* JobId
is returned from
* StartDocumentTextDetection
. A JobId
* value is only valid for 7 days.
*
* A unique identifier for the text detection job. The JobId
is
* returned from StartDocumentTextDetection
. A
* JobId
value is only valid for 7 days.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @param jobId
* A unique identifier for the text detection job. The
* JobId
is returned from
* StartDocumentTextDetection
. A JobId
* value is only valid for 7 days.
*
* A unique identifier for the text detection job. The JobId
is
* returned from StartDocumentTextDetection
. A
* JobId
value is only valid for 7 days.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @param jobId
* A unique identifier for the text detection job. The
* JobId
is returned from
* StartDocumentTextDetection
. A JobId
* value is only valid for 7 days.
*
* The maximum number of results to return per paginated call. The largest * value you can specify is 1,000. If you specify a value greater than * 1,000, a maximum of 1,000 results is returned. The default value is * 1,000. *
*
* Constraints:
* Range: 1 -
*
* @return
* The maximum number of results to return per paginated call. The * largest value you can specify is 1,000. If you specify a value * greater than 1,000, a maximum of 1,000 results is returned. The * default value is 1,000. *
*/ public Integer getMaxResults() { return maxResults; } /** ** The maximum number of results to return per paginated call. The largest * value you can specify is 1,000. If you specify a value greater than * 1,000, a maximum of 1,000 results is returned. The default value is * 1,000. *
*
* Constraints:
* Range: 1 -
*
* @param maxResults
* The maximum number of results to return per paginated call. * The largest value you can specify is 1,000. If you specify a * value greater than 1,000, a maximum of 1,000 results is * returned. The default value is 1,000. *
*/ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** ** The maximum number of results to return per paginated call. The largest * value you can specify is 1,000. If you specify a value greater than * 1,000, a maximum of 1,000 results is returned. The default value is * 1,000. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Range: 1 -
*
* @param maxResults
* The maximum number of results to return per paginated call. * The largest value you can specify is 1,000. If you specify a * value greater than 1,000, a maximum of 1,000 results is * returned. The default value is 1,000. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetDocumentTextDetectionRequest withMaxResults(Integer maxResults) { this.maxResults = maxResults; return this; } /** ** If the previous response was incomplete (because there are more blocks to * retrieve), Amazon Textract returns a pagination token in the response. * You can use this pagination token to retrieve the next set of blocks. *
*
* Constraints:
* Length: 1 - 255
* Pattern: .*\S.*
*
* @return
* If the previous response was incomplete (because there are more * blocks to retrieve), Amazon Textract returns a pagination token * in the response. You can use this pagination token to retrieve * the next set of blocks. *
*/ public String getNextToken() { return nextToken; } /** ** If the previous response was incomplete (because there are more blocks to * retrieve), Amazon Textract returns a pagination token in the response. * You can use this pagination token to retrieve the next set of blocks. *
*
* Constraints:
* Length: 1 - 255
* Pattern: .*\S.*
*
* @param nextToken
* If the previous response was incomplete (because there are * more blocks to retrieve), Amazon Textract returns a pagination * token in the response. You can use this pagination token to * retrieve the next set of blocks. *
*/ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** ** If the previous response was incomplete (because there are more blocks to * retrieve), Amazon Textract returns a pagination token in the response. * You can use this pagination token to retrieve the next set of blocks. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 255
* Pattern: .*\S.*
*
* @param nextToken
* If the previous response was incomplete (because there are * more blocks to retrieve), Amazon Textract returns a pagination * token in the response. You can use this pagination token to * retrieve the next set of blocks. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetDocumentTextDetectionRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getJobId() != null) sb.append("JobId: " + getJobId() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetDocumentTextDetectionRequest == false) return false; GetDocumentTextDetectionRequest other = (GetDocumentTextDetectionRequest) obj; if (other.getJobId() == null ^ this.getJobId() == null) return false; if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; return true; } }