AnalyzeDocumentResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.textract.model.AnalyzeDocumentResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AnalyzeDocumentResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalyzeDocumentResult()

Constructors
Constructor and Description
`AnalyzeDocumentResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalyzeDocumentResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAnalyzeDocumentModelVersion()` The version of the model used to analyze the document.
`List<Block>`	`getBlocks()` The items that are detected and analyzed by `AnalyzeDocument`.
`DocumentMetadata`	`getDocumentMetadata()` Metadata about the analyzed document.
`HumanLoopActivationOutput`	`getHumanLoopActivationOutput()` Shows the results of the human in the loop evaluation.
`int`	`hashCode()`
`void`	`setAnalyzeDocumentModelVersion(String analyzeDocumentModelVersion)` The version of the model used to analyze the document.
`void`	`setBlocks(Collection<Block> blocks)` The items that are detected and analyzed by `AnalyzeDocument`.
`void`	`setDocumentMetadata(DocumentMetadata documentMetadata)` Metadata about the analyzed document.
`void`	`setHumanLoopActivationOutput(HumanLoopActivationOutput humanLoopActivationOutput)` Shows the results of the human in the loop evaluation.
`String`	`toString()` Returns a string representation of this object.
`AnalyzeDocumentResult`	`withAnalyzeDocumentModelVersion(String analyzeDocumentModelVersion)` The version of the model used to analyze the document.
`AnalyzeDocumentResult`	`withBlocks(Block... blocks)` The items that are detected and analyzed by `AnalyzeDocument`.
`AnalyzeDocumentResult`	`withBlocks(Collection<Block> blocks)` The items that are detected and analyzed by `AnalyzeDocument`.
`AnalyzeDocumentResult`	`withDocumentMetadata(DocumentMetadata documentMetadata)` Metadata about the analyzed document.
`AnalyzeDocumentResult`	`withHumanLoopActivationOutput(HumanLoopActivationOutput humanLoopActivationOutput)` Shows the results of the human in the loop evaluation.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnalyzeDocumentResult
```
public AnalyzeDocumentResult()
```
- Method Detail
  - setDocumentMetadata
```
public void setDocumentMetadata(DocumentMetadata documentMetadata)
```
    Metadata about the analyzed document. An example is the number of pages.
    
    Parameters:
    
    documentMetadata - Metadata about the analyzed document. An example is the number of pages.
  - getDocumentMetadata
```
public DocumentMetadata getDocumentMetadata()
```
    Metadata about the analyzed document. An example is the number of pages.
    
    Returns:
    
    Metadata about the analyzed document. An example is the number of pages.
  - withDocumentMetadata
```
public AnalyzeDocumentResult withDocumentMetadata(DocumentMetadata documentMetadata)
```
    Metadata about the analyzed document. An example is the number of pages.
    
    Parameters:
    
    documentMetadata - Metadata about the analyzed document. An example is the number of pages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBlocks
```
public List<Block> getBlocks()
```
    The items that are detected and analyzed by AnalyzeDocument.
    
    Returns:
    
    The items that are detected and analyzed by AnalyzeDocument.
  - setBlocks
```
public void setBlocks(Collection<Block> blocks)
```
    The items that are detected and analyzed by AnalyzeDocument.
    
    Parameters:
    
    blocks - The items that are detected and analyzed by AnalyzeDocument.
  - withBlocks
```
public AnalyzeDocumentResult withBlocks(Block... blocks)
```
    The items that are detected and analyzed by AnalyzeDocument.
    
    NOTE: This method appends the values to the existing list (if any). Use setBlocks(java.util.Collection) or withBlocks(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    blocks - The items that are detected and analyzed by AnalyzeDocument.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBlocks
```
public AnalyzeDocumentResult withBlocks(Collection<Block> blocks)
```
    The items that are detected and analyzed by AnalyzeDocument.
    
    Parameters:
    
    blocks - The items that are detected and analyzed by AnalyzeDocument.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHumanLoopActivationOutput
```
public void setHumanLoopActivationOutput(HumanLoopActivationOutput humanLoopActivationOutput)
```
    Shows the results of the human in the loop evaluation.
    
    Parameters:
    
    humanLoopActivationOutput - Shows the results of the human in the loop evaluation.
  - getHumanLoopActivationOutput
```
public HumanLoopActivationOutput getHumanLoopActivationOutput()
```
    Shows the results of the human in the loop evaluation.
    
    Returns:
    
    Shows the results of the human in the loop evaluation.
  - withHumanLoopActivationOutput
```
public AnalyzeDocumentResult withHumanLoopActivationOutput(HumanLoopActivationOutput humanLoopActivationOutput)
```
    Shows the results of the human in the loop evaluation.
    
    Parameters:
    
    humanLoopActivationOutput - Shows the results of the human in the loop evaluation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAnalyzeDocumentModelVersion
```
public void setAnalyzeDocumentModelVersion(String analyzeDocumentModelVersion)
```
    The version of the model used to analyze the document.
    
    Parameters:
    
    analyzeDocumentModelVersion - The version of the model used to analyze the document.
  - getAnalyzeDocumentModelVersion
```
public String getAnalyzeDocumentModelVersion()
```
    The version of the model used to analyze the document.
    
    Returns:
    
    The version of the model used to analyze the document.
  - withAnalyzeDocumentModelVersion
```
public AnalyzeDocumentResult withAnalyzeDocumentModelVersion(String analyzeDocumentModelVersion)
```
    The version of the model used to analyze the document.
    
    Parameters:
    
    analyzeDocumentModelVersion - The version of the model used to analyze the 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 AnalyzeDocumentResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class AnalyzeDocumentResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

AnalyzeDocumentResult

Method Detail

setDocumentMetadata

getDocumentMetadata

withDocumentMetadata

getBlocks

setBlocks

withBlocks

withBlocks

setHumanLoopActivationOutput

getHumanLoopActivationOutput

withHumanLoopActivationOutput

setAnalyzeDocumentModelVersion

getAnalyzeDocumentModelVersion

withAnalyzeDocumentModelVersion

toString

equals

hashCode

clone