com.amazonaws.services.textract.model

Class AnalyzeDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.textract.model.AnalyzeDocumentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AnalyzeDocumentRequest
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
AnalyzeDocumentRequest()

Method Summary

Modifier and Type	Method and Description
AnalyzeDocumentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AdaptersConfig	getAdaptersConfig() Specifies the adapter to be used when analyzing a document.
Document	getDocument() The input document as base64-encoded bytes or an Amazon S3 object.
List<String>	getFeatureTypes() A list of the types of analysis to perform.
HumanLoopConfig	getHumanLoopConfig() Sets the configuration for the human in the loop workflow for analyzing documents.
QueriesConfig	getQueriesConfig() Contains Queries and the alias for those Queries, as determined by the input.
int	hashCode()
void	setAdaptersConfig(AdaptersConfig adaptersConfig) Specifies the adapter to be used when analyzing a document.
void	setDocument(Document document) The input document as base64-encoded bytes or an Amazon S3 object.
void	setFeatureTypes(Collection<String> featureTypes) A list of the types of analysis to perform.
void	setHumanLoopConfig(HumanLoopConfig humanLoopConfig) Sets the configuration for the human in the loop workflow for analyzing documents.
void	setQueriesConfig(QueriesConfig queriesConfig) Contains Queries and the alias for those Queries, as determined by the input.
String	toString() Returns a string representation of this object.
AnalyzeDocumentRequest	withAdaptersConfig(AdaptersConfig adaptersConfig) Specifies the adapter to be used when analyzing a document.
AnalyzeDocumentRequest	withDocument(Document document) The input document as base64-encoded bytes or an Amazon S3 object.
AnalyzeDocumentRequest	withFeatureTypes(Collection<String> featureTypes) A list of the types of analysis to perform.
AnalyzeDocumentRequest	withFeatureTypes(FeatureType... featureTypes) A list of the types of analysis to perform.
AnalyzeDocumentRequest	withFeatureTypes(String... featureTypes) A list of the types of analysis to perform.
AnalyzeDocumentRequest	withHumanLoopConfig(HumanLoopConfig humanLoopConfig) Sets the configuration for the human in the loop workflow for analyzing documents.
AnalyzeDocumentRequest	withQueriesConfig(QueriesConfig queriesConfig) Contains Queries and the alias for those Queries, as determined by the input.

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

AnalyzeDocumentRequest

public AnalyzeDocumentRequest()

Method Detail

setDocument

public void setDocument(Document document)

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Parameters:

document - The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

getDocument

public Document getDocument()

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Returns:

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

withDocument

public AnalyzeDocumentRequest withDocument(Document document)

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

Parameters:

document - The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG, PNG, PDF, or TIFF format.

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.

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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

See Also:

FeatureType

withFeatureTypes

public AnalyzeDocumentRequest 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Returns:

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

See Also:

FeatureType

withFeatureTypes

public AnalyzeDocumentRequest 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Returns:

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

See Also:

FeatureType

withFeatureTypes

public AnalyzeDocumentRequest 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to 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 form data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list to return information about the layout of the document. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes).

Returns:

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

See Also:

FeatureType

setHumanLoopConfig

public void setHumanLoopConfig(HumanLoopConfig humanLoopConfig)

Sets the configuration for the human in the loop workflow for analyzing documents.

Parameters:

humanLoopConfig - Sets the configuration for the human in the loop workflow for analyzing documents.

getHumanLoopConfig

public HumanLoopConfig getHumanLoopConfig()

Sets the configuration for the human in the loop workflow for analyzing documents.

Returns:

Sets the configuration for the human in the loop workflow for analyzing documents.

withHumanLoopConfig

public AnalyzeDocumentRequest withHumanLoopConfig(HumanLoopConfig humanLoopConfig)

Sets the configuration for the human in the loop workflow for analyzing documents.

Parameters:

humanLoopConfig - Sets the configuration for the human in the loop workflow for analyzing documents.

Returns:

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

setQueriesConfig

public void setQueriesConfig(QueriesConfig queriesConfig)

Contains Queries and the alias for those Queries, as determined by the input.

Parameters:

queriesConfig - Contains Queries and the alias for those Queries, as determined by the input.

getQueriesConfig

public QueriesConfig getQueriesConfig()

Contains Queries and the alias for those Queries, as determined by the input.

Returns:

Contains Queries and the alias for those Queries, as determined by the input.

withQueriesConfig

public AnalyzeDocumentRequest withQueriesConfig(QueriesConfig queriesConfig)

Contains Queries and the alias for those Queries, as determined by the input.

Parameters:

queriesConfig - Contains Queries and the alias for those Queries, as determined by the input.

Returns:

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

setAdaptersConfig

public void setAdaptersConfig(AdaptersConfig adaptersConfig)

Specifies the adapter to be used when analyzing a document.

Parameters:

adaptersConfig - Specifies the adapter to be used when analyzing a document.

getAdaptersConfig

public AdaptersConfig getAdaptersConfig()

Specifies the adapter to be used when analyzing a document.

Returns:

Specifies the adapter to be used when analyzing a document.

withAdaptersConfig

public AnalyzeDocumentRequest withAdaptersConfig(AdaptersConfig adaptersConfig)

Specifies the adapter to be used when analyzing a document.

Parameters:

adaptersConfig - Specifies the adapter to be used when analyzing a document.

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 AnalyzeDocumentRequest 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()