com.amazonaws.services.textract.model

Class StartDocumentAnalysisRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.textract.model.StartDocumentAnalysisRequest

All Implemented Interfaces:

Serializable, Cloneable

public class StartDocumentAnalysisRequest
extends AmazonWebServiceRequest
implements Serializable

Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements.

StartDocumentAnalysis can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

StartDocumentAnalysis returns a job identifier ( JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis 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.

For more information, see Document Text Analysis.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartDocumentAnalysisRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClientRequestToken() The idempotent token that you use to identify the start request.
DocumentLocation	getDocumentLocation() The location of the document to be processed.
List<String>	getFeatureTypes() A list of the types of analysis to perform.
String	getJobTag() An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic.
NotificationChannel	getNotificationChannel() The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) The idempotent token that you use to identify the start request.
void	setDocumentLocation(DocumentLocation documentLocation) The location of the document to be processed.
void	setFeatureTypes(Collection<String> featureTypes) A list of the types of analysis to perform.
void	setJobTag(String jobTag) An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic.
void	setNotificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StartDocumentAnalysisRequest	withClientRequestToken(String clientRequestToken) The idempotent token that you use to identify the start request.
StartDocumentAnalysisRequest	withDocumentLocation(DocumentLocation documentLocation) The location of the document to be processed.
StartDocumentAnalysisRequest	withFeatureTypes(Collection<String> featureTypes) A list of the types of analysis to perform.
StartDocumentAnalysisRequest	withFeatureTypes(String... featureTypes) A list of the types of analysis to perform.
StartDocumentAnalysisRequest	withJobTag(String jobTag) An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic.
StartDocumentAnalysisRequest	withNotificationChannel(NotificationChannel notificationChannel) The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartDocumentAnalysisRequest

public StartDocumentAnalysisRequest()

Method Detail

getDocumentLocation

public DocumentLocation getDocumentLocation()

The location of the document to be processed.

Returns:

The location of the document to be processed.

setDocumentLocation

public void setDocumentLocation(DocumentLocation documentLocation)

The location of the document to be processed.

Parameters:

documentLocation -

The location of the document to be processed.

withDocumentLocation

public StartDocumentAnalysisRequest withDocumentLocation(DocumentLocation documentLocation)

The location of the document to be processed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

documentLocation -

The location of the document to be processed.

Returns:

A reference to this updated object so that method calls can be chained together.

getFeatureTypes

public List<String> getFeatureTypes()

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns:

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

setFeatureTypes

public void setFeatureTypes(Collection<String> featureTypes)

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Parameters:

featureTypes -

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

withFeatureTypes

public StartDocumentAnalysisRequest withFeatureTypes(String... featureTypes)

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

featureTypes -

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns:

A reference to this updated object so that method calls can be chained together.

withFeatureTypes

public StartDocumentAnalysisRequest withFeatureTypes(Collection<String> featureTypes)

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements ( SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

featureTypes -

A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientRequestToken

public String getClientRequestToken()

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Returns:

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

clientRequestToken -

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

withClientRequestToken

public StartDocumentAnalysisRequest withClientRequestToken(String clientRequestToken)

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

clientRequestToken -

The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

Returns:

A reference to this updated object so that method calls can be chained together.

getJobTag

public String getJobTag()

An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.\-:]+

Returns:

An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

setJobTag

public void setJobTag(String jobTag)

An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.\-:]+

Parameters:

jobTag -

An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

withJobTag

public StartDocumentAnalysisRequest withJobTag(String jobTag)

An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9_.\-:]+

Parameters:

jobTag -

An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

Returns:

A reference to this updated object so that method calls can be chained together.

getNotificationChannel

public NotificationChannel getNotificationChannel()

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Returns:

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

setNotificationChannel

public void setNotificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Parameters:

notificationChannel -

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

withNotificationChannel

public StartDocumentAnalysisRequest withNotificationChannel(NotificationChannel notificationChannel)

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Returns a reference to this object so that method calls can be chained together.

Parameters:

notificationChannel -

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object