com.amazonaws.services.textract.model

Class GetDocumentTextDetectionResult

java.lang.Object

com.amazonaws.services.textract.model.GetDocumentTextDetectionResult

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetDocumentTextDetectionResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<Block>	getBlocks() The results of the text-detection operation.
java.lang.String	getDetectDocumentTextModelVersion()
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 text-detection operation for the document.
int	hashCode()
void	setBlocks(java.util.Collection<Block> blocks) The results of the text-detection operation.
void	setDetectDocumentTextModelVersion(java.lang.String detectDocumentTextModelVersion)
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 text-detection operation for the document.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetDocumentTextDetectionResult	withBlocks(Block... blocks) The results of the text-detection operation.
GetDocumentTextDetectionResult	withBlocks(java.util.Collection<Block> blocks) The results of the text-detection operation.
GetDocumentTextDetectionResult	withDetectDocumentTextModelVersion(java.lang.String detectDocumentTextModelVersion)
GetDocumentTextDetectionResult	withDocumentMetadata(DocumentMetadata documentMetadata) Information about a document that Amazon Textract processed.
GetDocumentTextDetectionResult	withJobStatus(JobStatus jobStatus) The current status of the text detection job.
GetDocumentTextDetectionResult	withJobStatus(java.lang.String jobStatus) The current status of the text detection job.
GetDocumentTextDetectionResult	withNextToken(java.lang.String nextToken) If the response is truncated, Amazon Textract returns this token.
GetDocumentTextDetectionResult	withStatusMessage(java.lang.String statusMessage) Returns if the detection job could not be completed.
GetDocumentTextDetectionResult	withWarnings(java.util.Collection<Warning> warnings) A list of warnings that occurred during the text-detection operation for the document.
GetDocumentTextDetectionResult	withWarnings(Warning... warnings) A list of warnings that occurred during the text-detection operation for the document.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetDocumentTextDetectionResult

public GetDocumentTextDetectionResult()

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 GetDocumentTextDetectionResult 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 GetDocumentTextDetectionResult 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 GetDocumentTextDetectionResult 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 GetDocumentTextDetectionResult 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-detection operation.

Returns:

The results of the text-detection operation.

setBlocks

public void setBlocks(java.util.Collection<Block> blocks)

The results of the text-detection operation.

Parameters:

blocks -

The results of the text-detection operation.

withBlocks

public GetDocumentTextDetectionResult withBlocks(Block... blocks)

The results of the text-detection operation.

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

Parameters:

blocks -

The results of the text-detection operation.

Returns:

A reference to this updated object so that method calls can be chained together.

withBlocks

public GetDocumentTextDetectionResult withBlocks(java.util.Collection<Block> blocks)

The results of the text-detection operation.

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

Parameters:

blocks -

The results of the text-detection 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 text-detection operation for the document.

Returns:

A list of warnings that occurred during the text-detection operation for the document.

setWarnings

public void setWarnings(java.util.Collection<Warning> warnings)

A list of warnings that occurred during the text-detection operation for the document.

Parameters:

warnings -

A list of warnings that occurred during the text-detection operation for the document.

withWarnings

public GetDocumentTextDetectionResult withWarnings(Warning... warnings)

A list of warnings that occurred during the text-detection operation for the document.

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

Parameters:

warnings -

A list of warnings that occurred during the text-detection operation for the document.

Returns:

A reference to this updated object so that method calls can be chained together.

withWarnings

public GetDocumentTextDetectionResult withWarnings(java.util.Collection<Warning> warnings)

A list of warnings that occurred during the text-detection operation for the document.

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

Parameters:

warnings -

A list of warnings that occurred during the text-detection operation for the document.

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

getDetectDocumentTextModelVersion

public java.lang.String getDetectDocumentTextModelVersion()

Returns:

setDetectDocumentTextModelVersion

public void setDetectDocumentTextModelVersion(java.lang.String detectDocumentTextModelVersion)

Parameters:

detectDocumentTextModelVersion -

withDetectDocumentTextModelVersion

public GetDocumentTextDetectionResult withDetectDocumentTextModelVersion(java.lang.String detectDocumentTextModelVersion)

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

Parameters:

detectDocumentTextModelVersion -

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