com.amazonaws.services.textract.model

Class GetDocumentAnalysisResult

java.lang.Object

com.amazonaws.services.textract.model.GetDocumentAnalysisResult

All Implemented Interfaces:

Serializable

public class GetDocumentAnalysisResult
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetDocumentAnalysisResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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() The current status of an asynchronous document analysis operation.
List<Warning>	getWarnings() A list of warnings that occurred during the document analysis operation.
int	hashCode()
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(JobStatus jobStatus) The current status of the text detection job.
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) The current status of an asynchronous document analysis operation.
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; useful for testing and debugging.
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) The current status of an asynchronous document analysis operation.
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 java.lang.Object

clone, finalize, 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 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(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(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 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(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(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 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.

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(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 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.

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(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 String getStatusMessage()

The current status of an asynchronous document analysis operation.

Returns:

The current status of an asynchronous document analysis operation.

setStatusMessage

public void setStatusMessage(String statusMessage)

The current status of an asynchronous document analysis operation.

Parameters:

statusMessage -

The current status of an asynchronous document analysis operation.

withStatusMessage

public GetDocumentAnalysisResult withStatusMessage(String statusMessage)

The current status of an asynchronous document analysis operation.

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

Parameters:

statusMessage -

The current status of an asynchronous document analysis operation.

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