AnalyzeDocumentRequest (AWS SDK for Android - Amazon Textract 2.15.2 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.textract.model.AnalyzeDocumentRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class AnalyzeDocumentRequest
extends AmazonWebServiceRequest
implements Serializable
```
Analyzes an input document for relationships between detected items.

The types of information returned are as follows:
- Words and lines that are related to nearby lines and words. 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.
- Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
- Lines and words of text. A LINE Block object contains one or more WORD Block objects.
You can choose which type of analysis to perform by specifying the FeatureTypes list.

The output is returned in a list of BLOCK objects.

AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

For more information, see Document Text Analysis.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalyzeDocumentRequest()

Constructors
Constructor and Description
`AnalyzeDocumentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`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.
`int`	`hashCode()`
`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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`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(String... featureTypes)` A list of the types of analysis to perform.

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
  - AnalyzeDocumentRequest
```
public AnalyzeDocumentRequest()
```
- Method Detail
  - 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 JPG or PNG format.
    
    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes 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 JPG or PNG format.
    
    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
  - 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 JPG or PNG format.
    
    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes 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 JPG or PNG format.
    
    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes 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 JPG or PNG format.
    
    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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 JPG or PNG format.
    
    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
    
    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 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 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.
  - 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 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 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.
  - 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 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 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 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 reference to this updated object so that method calls can be chained together.
  - 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 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 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 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 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

Class AnalyzeDocumentRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AnalyzeDocumentRequest

Method Detail

getDocument

setDocument

withDocument

getFeatureTypes

setFeatureTypes

withFeatureTypes

withFeatureTypes

toString

hashCode

equals