* Gets the results for an Amazon Textract asynchronous operation that analyzes * text in a document. *
*
* You start asynchronous text analysis by calling StartDocumentAnalysis,
* which returns a job identifier (JobId). When the text analysis
* 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 StartDocumentAnalysis. 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
* GetDocumentAnalysis, and pass the job identifier (
* JobId) from the initial call to
* StartDocumentAnalysis.
*
* GetDocumentAnalysis returns an array of Block objects.
* The following types of information are returned:
*
* Form data (key-value pairs). The related information is returned in two
* Block objects, each of type KEY_VALUE_SET: a KEY
* Block object and a VALUE Block object. For example,
* Name: Ana Silva Carolina contains a key and value. Name: is the
* key. Ana Silva Carolina is the value.
*
* Table and table cell data. A TABLE Block object contains
* information about a detected table. A CELL Block object is
* returned for each cell in a table.
*
* Lines and words of text. A LINE Block object contains one or
* more WORD Block objects. All lines and words that are detected
* in the document are returned (including text that doesn't have a relationship
* with the value of the StartDocumentAnalysis
* FeatureTypes input parameter).
*
* Query. A QUERY Block object contains the query text, alias and link to the * associated Query results block object. *
** Query Results. A QUERY_RESULT Block object contains the answer to the query * and an ID that connects it to the query asked. This Block also contains a * confidence score. *
*
* While processing a document with queries, look out for
* INVALID_REQUEST_PARAMETERS output. This indicates that either
* the per page query limit has been exceeded or that the operation is trying to
* query a page in the document which doesn’t exist.
*
* Selection elements such as check boxes and option buttons (radio buttons) can
* be detected in form data and in tables. A SELECTION_ELEMENT
* Block object contains information about a selection element,
* including the selection status.
*
* 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 GetDocumentAnalysis, and
* populate the NextToken request parameter with the token value
* that's returned from the previous call to GetDocumentAnalysis.
*
* For more information, see Document Text Analysis. *
*/ public class GetDocumentAnalysisRequest extends AmazonWebServiceRequest implements Serializable { /** *
* A unique identifier for the text-detection job. The JobId is
* returned from StartDocumentAnalysis. 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 that 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 StartDocumentAnalysis. 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
* StartDocumentAnalysis. A JobId value is
* only valid for 7 days.
*
* A unique identifier for the text-detection job. The JobId is
* returned from StartDocumentAnalysis. 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
* StartDocumentAnalysis. A JobId value
* is only valid for 7 days.
*
* A unique identifier for the text-detection job. The JobId is
* returned from StartDocumentAnalysis. 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
* StartDocumentAnalysis. A JobId value
* is only valid for 7 days.
*
* The maximum number of results to return per paginated call. The largest * value that 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 that 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 that 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 that 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 that 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 that 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 GetDocumentAnalysisRequest 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 GetDocumentAnalysisRequest 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 GetDocumentAnalysisRequest == false) return false; GetDocumentAnalysisRequest other = (GetDocumentAnalysisRequest) 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; } }