GetDocumentAnalysisResult (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.textract.model.GetDocumentAnalysisResult

All Implemented Interfaces:: java.io.Serializable

public class GetDocumentAnalysisResult
extends java.lang.Object
implements java.io.Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetDocumentAnalysisResult()

Constructors
Constructor and Description
`GetDocumentAnalysisResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAnalyzeDocumentModelVersion()`
`java.util.List<Block>`	`getBlocks()` The results of the text-analysis operation.
`DocumentMetadata`	`getDocumentMetadata()` Information about a document that Amazon Textract processed.
`java.lang.String`	`getJobStatus()` The current status of the text detection job.
`java.lang.String`	`getNextToken()` If the response is truncated, Amazon Textract returns this token.
`java.lang.String`	`getStatusMessage()` Returns if the detection job could not be completed.
`java.util.List<Warning>`	`getWarnings()` A list of warnings that occurred during the document-analysis operation.
`int`	`hashCode()`
`void`	`setAnalyzeDocumentModelVersion(java.lang.String analyzeDocumentModelVersion)`
`void`	`setBlocks(java.util.Collection<Block> blocks)` The results of the text-analysis operation.
`void`	`setDocumentMetadata(DocumentMetadata documentMetadata)` Information about a document that Amazon Textract processed.
`void`	`setJobStatus(JobStatus jobStatus)` The current status of the text detection job.
`void`	`setJobStatus(java.lang.String jobStatus)` The current status of the text detection job.
`void`	`setNextToken(java.lang.String nextToken)` If the response is truncated, Amazon Textract returns this token.
`void`	`setStatusMessage(java.lang.String statusMessage)` Returns if the detection job could not be completed.
`void`	`setWarnings(java.util.Collection<Warning> warnings)` A list of warnings that occurred during the document-analysis operation.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetDocumentAnalysisResult`	`withAnalyzeDocumentModelVersion(java.lang.String analyzeDocumentModelVersion)`
`GetDocumentAnalysisResult`	`withBlocks(Block... blocks)` The results of the text-analysis operation.
`GetDocumentAnalysisResult`	`withBlocks(java.util.Collection<Block> blocks)` The results of the text-analysis operation.
`GetDocumentAnalysisResult`	`withDocumentMetadata(DocumentMetadata documentMetadata)` Information about a document that Amazon Textract processed.
`GetDocumentAnalysisResult`	`withJobStatus(JobStatus jobStatus)` The current status of the text detection job.
`GetDocumentAnalysisResult`	`withJobStatus(java.lang.String jobStatus)` The current status of the text detection job.
`GetDocumentAnalysisResult`	`withNextToken(java.lang.String nextToken)` If the response is truncated, Amazon Textract returns this token.
`GetDocumentAnalysisResult`	`withStatusMessage(java.lang.String statusMessage)` Returns if the detection job could not be completed.
`GetDocumentAnalysisResult`	`withWarnings(java.util.Collection<Warning> warnings)` A list of warnings that occurred during the document-analysis operation.
`GetDocumentAnalysisResult`	`withWarnings(Warning... warnings)` A list of warnings that occurred during the document-analysis operation.

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

- Constructor Detail
  - GetDocumentAnalysisResult
```
public GetDocumentAnalysisResult()
```
- Method Detail
  - getDocumentMetadata
```
public DocumentMetadata getDocumentMetadata()
```
    Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
    
    Returns:
    
    Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
  - setDocumentMetadata
```
public void setDocumentMetadata(DocumentMetadata documentMetadata)
```
    Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
    
    Parameters:
    
    documentMetadata -
    Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
  - withDocumentMetadata
```
public GetDocumentAnalysisResult withDocumentMetadata(DocumentMetadata documentMetadata)
```
    Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    documentMetadata -
    Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getJobStatus
```
public java.lang.String getJobStatus()
```
    The current status of the text detection job.
    
    Constraints:
    Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS
    
    Returns:
    
    The current status of the text detection job.
    
    See Also:
    
    JobStatus
  - setJobStatus
```
public void setJobStatus(java.lang.String jobStatus)
```
    The current status of the text detection job.
    
    Constraints:
    Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS
    
    Parameters:
    
    jobStatus -
    The current status of the text detection job.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public GetDocumentAnalysisResult withJobStatus(java.lang.String jobStatus)
```
    The current status of the text detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS
    
    Parameters:
    
    jobStatus -
    The current status of the text detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setJobStatus
```
public void setJobStatus(JobStatus jobStatus)
```
    The current status of the text detection job.
    
    Constraints:
    Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS
    
    Parameters:
    
    jobStatus -
    The current status of the text detection job.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public GetDocumentAnalysisResult withJobStatus(JobStatus jobStatus)
```
    The current status of the text detection job.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED, PARTIAL_SUCCESS
    
    Parameters:
    
    jobStatus -
    The current status of the text detection job.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - getNextToken
```
public java.lang.String getNextToken()
```
    If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
    
    Constraints:
    Length: 1 - 255
    Pattern: .*\S.*
    
    Returns:
    
    If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
    
    Constraints:
    Length: 1 - 255
    Pattern: .*\S.*
    
    Parameters:
    
    nextToken -
    If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
  - withNextToken
```
public GetDocumentAnalysisResult withNextToken(java.lang.String nextToken)
```
    If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 255
    Pattern: .*\S.*
    
    Parameters:
    
    nextToken -
    If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getBlocks
```
public java.util.List<Block> getBlocks()
```
    The results of the text-analysis operation.
    
    Returns:
    
    The results of the text-analysis operation.
  - setBlocks
```
public void setBlocks(java.util.Collection<Block> blocks)
```
    The results of the text-analysis operation.
    
    Parameters:
    
    blocks -
    The results of the text-analysis operation.
  - withBlocks
```
public GetDocumentAnalysisResult withBlocks(Block... blocks)
```
    The results of the text-analysis operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    blocks -
    The results of the text-analysis operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withBlocks
```
public GetDocumentAnalysisResult withBlocks(java.util.Collection<Block> blocks)
```
    The results of the text-analysis operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    blocks -
    The results of the text-analysis operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getWarnings
```
public java.util.List<Warning> getWarnings()
```
    A list of warnings that occurred during the document-analysis operation.
    
    Returns:
    
    A list of warnings that occurred during the document-analysis operation.
  - setWarnings
```
public void setWarnings(java.util.Collection<Warning> warnings)
```
    A list of warnings that occurred during the document-analysis operation.
    
    Parameters:
    
    warnings -
    A list of warnings that occurred during the document-analysis operation.
  - withWarnings
```
public GetDocumentAnalysisResult withWarnings(Warning... warnings)
```
    A list of warnings that occurred during the document-analysis operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    warnings -
    A list of warnings that occurred during the document-analysis operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withWarnings
```
public GetDocumentAnalysisResult withWarnings(java.util.Collection<Warning> warnings)
```
    A list of warnings that occurred during the document-analysis operation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    warnings -
    A list of warnings that occurred during the document-analysis operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStatusMessage
```
public java.lang.String getStatusMessage()
```
    Returns if the detection job could not be completed. Contains explanation for what error occured.
    
    Returns:
    
    Returns if the detection job could not be completed. Contains explanation for what error occured.
  - setStatusMessage
```
public void setStatusMessage(java.lang.String statusMessage)
```
    Returns if the detection job could not be completed. Contains explanation for what error occured.
    
    Parameters:
    
    statusMessage -
    Returns if the detection job could not be completed. Contains explanation for what error occured.
  - withStatusMessage
```
public GetDocumentAnalysisResult withStatusMessage(java.lang.String statusMessage)
```
    Returns if the detection job could not be completed. Contains explanation for what error occured.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    statusMessage -
    Returns if the detection job could not be completed. Contains explanation for what error occured.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAnalyzeDocumentModelVersion
```
public java.lang.String getAnalyzeDocumentModelVersion()
```
    Returns:
  - setAnalyzeDocumentModelVersion
```
public void setAnalyzeDocumentModelVersion(java.lang.String analyzeDocumentModelVersion)
```
    Parameters:
    
    analyzeDocumentModelVersion -
  - withAnalyzeDocumentModelVersion
```
public GetDocumentAnalysisResult withAnalyzeDocumentModelVersion(java.lang.String analyzeDocumentModelVersion)
```
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyzeDocumentModelVersion -
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class GetDocumentAnalysisResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetDocumentAnalysisResult

Method Detail

getDocumentMetadata

setDocumentMetadata

withDocumentMetadata

getJobStatus

setJobStatus

withJobStatus

setJobStatus

withJobStatus

getNextToken

setNextToken

withNextToken

getBlocks

setBlocks

withBlocks

withBlocks

getWarnings

setWarnings

withWarnings

withWarnings

getStatusMessage

setStatusMessage

withStatusMessage

getAnalyzeDocumentModelVersion

setAnalyzeDocumentModelVersion

withAnalyzeDocumentModelVersion

toString

hashCode

equals