com.amazonaws.services.textract.model

Class GetDocumentAnalysisRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.textract.model.GetDocumentAnalysisRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetDocumentAnalysisRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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).

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetDocumentAnalysisRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobId() A unique identifier for the text-detection job.
java.lang.Integer	getMaxResults() The maximum number of results to return per paginated call.
java.lang.String	getNextToken() If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response.
int	hashCode()
void	setJobId(java.lang.String jobId) A unique identifier for the text-detection job.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of results to return per paginated call.
void	setNextToken(java.lang.String nextToken) If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetDocumentAnalysisRequest	withJobId(java.lang.String jobId) A unique identifier for the text-detection job.
GetDocumentAnalysisRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of results to return per paginated call.
GetDocumentAnalysisRequest	withNextToken(java.lang.String nextToken) If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetDocumentAnalysisRequest

public GetDocumentAnalysisRequest()

Method Detail

getJobId

public java.lang.String getJobId()

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-_]+$

Returns:

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

setJobId

public void setJobId(java.lang.String jobId)

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-_]+$

Parameters:

jobId -

A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis. A JobId value is only valid for 7 days.

withJobId

public GetDocumentAnalysisRequest withJobId(java.lang.String jobId)

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-_]+$

Parameters:

jobId -

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 updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

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 -

Returns:

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.

setMaxResults

public void setMaxResults(java.lang.Integer 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 -

Parameters:

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.

withMaxResults

public GetDocumentAnalysisRequest withMaxResults(java.lang.Integer 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 -

Parameters:

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 updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

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.*

Returns:

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.

setNextToken

public void setNextToken(java.lang.String 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.*

Parameters:

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.

withNextToken

public GetDocumentAnalysisRequest withNextToken(java.lang.String 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.*

Parameters:

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 updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object