GetDocumentAnalysisResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, 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
`GetDocumentAnalysisResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAnalyzeDocumentModelVersion()`
`List<Block>`	`getBlocks()` The results of the text-analysis operation.
`DocumentMetadata`	`getDocumentMetadata()` Information about a document that Amazon Textract processed.
`String`	`getJobStatus()` The current status of the text detection job.
`String`	`getNextToken()` If the response is truncated, Amazon Textract returns this token.
`String`	`getStatusMessage()` Returns if the detection job could not be completed.
`List<Warning>`	`getWarnings()` A list of warnings that occurred during the document-analysis operation.
`int`	`hashCode()`
`void`	`setAnalyzeDocumentModelVersion(String analyzeDocumentModelVersion)`
`void`	`setBlocks(Collection<Block> blocks)` The results of the text-analysis operation.
`void`	`setDocumentMetadata(DocumentMetadata documentMetadata)` Information about a document that Amazon Textract processed.
`void`	`setJobStatus(String jobStatus)` The current status of the text detection job.
`void`	`setNextToken(String nextToken)` If the response is truncated, Amazon Textract returns this token.
`void`	`setStatusMessage(String statusMessage)` Returns if the detection job could not be completed.
`void`	`setWarnings(Collection<Warning> warnings)` A list of warnings that occurred during the document-analysis operation.
`String`	`toString()` Returns a string representation of this object.
`GetDocumentAnalysisResult`	`withAnalyzeDocumentModelVersion(String analyzeDocumentModelVersion)`
`GetDocumentAnalysisResult`	`withBlocks(Block... blocks)` The results of the text-analysis operation.
`GetDocumentAnalysisResult`	`withBlocks(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(String jobStatus)` The current status of the text detection job.
`GetDocumentAnalysisResult`	`withNextToken(String nextToken)` If the response is truncated, Amazon Textract returns this token.
`GetDocumentAnalysisResult`	`withStatusMessage(String statusMessage)` Returns if the detection job could not be completed.
`GetDocumentAnalysisResult`	`withWarnings(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 com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetDocumentAnalysisResult
```
public GetDocumentAnalysisResult()
```
- Method Detail
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobStatus
```
public void setJobStatus(String jobStatus)
```
    The current status of the text detection job.
    
    Parameters:
    
    jobStatus - The current status of the text detection job.
    
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The current status of the text detection job.
    
    Returns:
    
    The current status of the text detection job.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public GetDocumentAnalysisResult withJobStatus(String jobStatus)
```
    The current status of the text detection job.
    
    Parameters:
    
    jobStatus - The current status of the text detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public GetDocumentAnalysisResult withJobStatus(JobStatus jobStatus)
```
    The current status of the text detection job.
    
    Parameters:
    
    jobStatus - The current status of the text detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setNextToken
```
public void setNextToken(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.
    
    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.
  - getNextToken
```
public 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.
    
    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.
  - withNextToken
```
public GetDocumentAnalysisResult withNextToken(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBlocks
```
public List<Block> getBlocks()
```
    The results of the text-analysis operation.
    
    Returns:
    
    The results of the text-analysis operation.
  - setBlocks
```
public void setBlocks(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.
    
    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 results of the text-analysis operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBlocks
```
public GetDocumentAnalysisResult withBlocks(Collection<Block> blocks)
```
    The results of the text-analysis operation.
    
    Parameters:
    
    blocks - The results of the text-analysis operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWarnings
```
public 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(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setWarnings(java.util.Collection) or withWarnings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    warnings - A list of warnings that occurred during the document-analysis operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWarnings
```
public GetDocumentAnalysisResult withWarnings(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusMessage
```
public void setStatusMessage(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.
  - getStatusMessage
```
public 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.
  - withStatusMessage
```
public GetDocumentAnalysisResult withStatusMessage(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAnalyzeDocumentModelVersion
```
public void setAnalyzeDocumentModelVersion(String analyzeDocumentModelVersion)
```
    Parameters:
    
    analyzeDocumentModelVersion -
  - getAnalyzeDocumentModelVersion
```
public String getAnalyzeDocumentModelVersion()
```
    Returns:
  - withAnalyzeDocumentModelVersion
```
public GetDocumentAnalysisResult withAnalyzeDocumentModelVersion(String analyzeDocumentModelVersion)
```
    Parameters:
    
    analyzeDocumentModelVersion -
    
    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 GetDocumentAnalysisResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetDocumentAnalysisResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetDocumentAnalysisResult

Method Detail

setDocumentMetadata

getDocumentMetadata

withDocumentMetadata

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setNextToken

getNextToken

withNextToken

getBlocks

setBlocks

withBlocks

withBlocks

getWarnings

setWarnings

withWarnings

withWarnings

setStatusMessage

getStatusMessage

withStatusMessage

setAnalyzeDocumentModelVersion

getAnalyzeDocumentModelVersion

withAnalyzeDocumentModelVersion

toString

equals

hashCode

clone