com.amazonaws.services.textract.model

Class StartDocumentAnalysisRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.textract.model.StartDocumentAnalysisRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartDocumentAnalysisRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartDocumentAnalysisRequest()

Method Summary

Modifier and Type	Method and Description
StartDocumentAnalysisRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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() The unique identifier you specify to identify the job in the completion status 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) The unique identifier you specify to identify the job in the completion status 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.
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(FeatureType... 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) The unique identifier you specify to identify the job in the completion status 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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartDocumentAnalysisRequest

public StartDocumentAnalysisRequest()

Method Detail

setDocumentLocation

public void setDocumentLocation(DocumentLocation documentLocation)

The location of the document to be processed.

Parameters:

documentLocation - The location of the document to be processed.

getDocumentLocation

public DocumentLocation getDocumentLocation()

The location of the document to be processed.

Returns:

The location of the document to be processed.

withDocumentLocation

public StartDocumentAnalysisRequest withDocumentLocation(DocumentLocation documentLocation)

The location of the document to be processed.

Parameters:

documentLocation - The location of the document to be processed.

Returns:

Returns a reference to this 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.

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.

See Also:

FeatureType

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.

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.

See Also:

FeatureType

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.

NOTE: This method appends the values to the existing list (if any). Use setFeatureTypes(java.util.Collection) or withFeatureTypes(java.util.Collection) if you want to override the existing values.

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.

Returns:

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

See Also:

FeatureType

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.

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.

Returns:

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

See Also:

FeatureType

withFeatureTypes

public StartDocumentAnalysisRequest withFeatureTypes(FeatureType... 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.

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.

Returns:

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

See Also:

FeatureType

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.

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.

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.

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.

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.

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:

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

setJobTag

public void setJobTag(String jobTag)

The unique identifier you specify to identify the job in the completion status that's published to the Amazon SNS topic.

Parameters:

jobTag - The unique identifier you specify to identify the job in the completion status that's published to the Amazon SNS topic.

getJobTag

public String getJobTag()

The unique identifier you specify to identify the job in the completion status that's published to the Amazon SNS topic.

Returns:

The unique identifier you specify to identify the job in the completion status that's published to the Amazon SNS topic.

withJobTag

public StartDocumentAnalysisRequest withJobTag(String jobTag)

The unique identifier you specify to identify the job in the completion status that's published to the Amazon SNS topic.

Parameters:

jobTag - The unique identifier you specify to identify the job in the completion status that's published to the Amazon SNS topic.

Returns:

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

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.

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.

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.

Parameters:

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

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartDocumentAnalysisRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()