com.amazonaws.services.rekognition.model

Class GetTextDetectionResult

java.lang.Object

com.amazonaws.services.rekognition.model.GetTextDetectionResult

All Implemented Interfaces:

java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetTextDetectionResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobStatus() Current status of the text detection job.
java.lang.String	getNextToken() If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
java.lang.String	getStatusMessage() If the job fails, StatusMessage provides a descriptive error message.
java.util.List<TextDetectionResult>	getTextDetections() An array of text detected in the video.
java.lang.String	getTextModelVersion() Version number of the text detection model that was used to detect text.
VideoMetadata	getVideoMetadata() Information about a video that Amazon Rekognition analyzed.
int	hashCode()
void	setJobStatus(java.lang.String jobStatus) Current status of the text detection job.
void	setJobStatus(VideoJobStatus jobStatus) Current status of the text detection job.
void	setNextToken(java.lang.String nextToken) If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
void	setStatusMessage(java.lang.String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
void	setTextDetections(java.util.Collection<TextDetectionResult> textDetections) An array of text detected in the video.
void	setTextModelVersion(java.lang.String textModelVersion) Version number of the text detection model that was used to detect text.
void	setVideoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition analyzed.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetTextDetectionResult	withJobStatus(java.lang.String jobStatus) Current status of the text detection job.
GetTextDetectionResult	withJobStatus(VideoJobStatus jobStatus) Current status of the text detection job.
GetTextDetectionResult	withNextToken(java.lang.String nextToken) If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
GetTextDetectionResult	withStatusMessage(java.lang.String statusMessage) If the job fails, StatusMessage provides a descriptive error message.
GetTextDetectionResult	withTextDetections(java.util.Collection<TextDetectionResult> textDetections) An array of text detected in the video.
GetTextDetectionResult	withTextDetections(TextDetectionResult... textDetections) An array of text detected in the video.
GetTextDetectionResult	withTextModelVersion(java.lang.String textModelVersion) Version number of the text detection model that was used to detect text.
GetTextDetectionResult	withVideoMetadata(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition analyzed.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetTextDetectionResult

public GetTextDetectionResult()

Method Detail

getJobStatus

public java.lang.String getJobStatus()

Current status of the text detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Returns:

Current status of the text detection job.

See Also:

VideoJobStatus

setJobStatus

public void setJobStatus(java.lang.String jobStatus)

Current status of the text detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

Current status of the text detection job.

See Also:

VideoJobStatus

withJobStatus

public GetTextDetectionResult withJobStatus(java.lang.String jobStatus)

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

Parameters:

jobStatus -

Current status of the text detection job.

Returns:

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

See Also:

VideoJobStatus

setJobStatus

public void setJobStatus(VideoJobStatus jobStatus)

Current status of the text detection job.

Constraints:
Allowed Values: IN_PROGRESS, SUCCEEDED, FAILED

Parameters:

jobStatus -

Current status of the text detection job.

See Also:

VideoJobStatus

withJobStatus

public GetTextDetectionResult withJobStatus(VideoJobStatus jobStatus)

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

Parameters:

jobStatus -

Current status of the text detection job.

Returns:

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

See Also:

VideoJobStatus

getStatusMessage

public java.lang.String getStatusMessage()

If the job fails, StatusMessage provides a descriptive error message.

Returns:

If the job fails, StatusMessage provides a descriptive error message.

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)

If the job fails, StatusMessage provides a descriptive error message.

Parameters:

statusMessage -

If the job fails, StatusMessage provides a descriptive error message.

withStatusMessage

public GetTextDetectionResult withStatusMessage(java.lang.String statusMessage)

If the job fails, StatusMessage provides a descriptive error message.

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

Parameters:

statusMessage -

If the job fails, StatusMessage provides a descriptive error message.

Returns:

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

getVideoMetadata

public VideoMetadata getVideoMetadata()

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

Returns:

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

setVideoMetadata

public void setVideoMetadata(VideoMetadata videoMetadata)

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

Parameters:

videoMetadata -

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

withVideoMetadata

public GetTextDetectionResult withVideoMetadata(VideoMetadata videoMetadata)

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

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

Parameters:

videoMetadata -

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

Returns:

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

getTextDetections

public java.util.List<TextDetectionResult> getTextDetections()

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

Returns:

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

setTextDetections

public void setTextDetections(java.util.Collection<TextDetectionResult> textDetections)

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

Parameters:

textDetections -

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

withTextDetections

public GetTextDetectionResult withTextDetections(TextDetectionResult... textDetections)

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

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

Parameters:

textDetections -

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

Returns:

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

withTextDetections

public GetTextDetectionResult withTextDetections(java.util.Collection<TextDetectionResult> textDetections)

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

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

Parameters:

textDetections -

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

Returns:

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

getNextToken

public java.lang.String getNextToken()

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

Constraints:
Length: - 255

Returns:

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

setNextToken

public void setNextToken(java.lang.String nextToken)

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

Constraints:
Length: - 255

Parameters:

nextToken -

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

withNextToken

public GetTextDetectionResult withNextToken(java.lang.String nextToken)

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

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

Constraints:
Length: - 255

Parameters:

nextToken -

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.

Returns:

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

getTextModelVersion

public java.lang.String getTextModelVersion()

Version number of the text detection model that was used to detect text.

Returns:

Version number of the text detection model that was used to detect text.

setTextModelVersion

public void setTextModelVersion(java.lang.String textModelVersion)

Version number of the text detection model that was used to detect text.

Parameters:

textModelVersion -

Version number of the text detection model that was used to detect text.

withTextModelVersion

public GetTextDetectionResult withTextModelVersion(java.lang.String textModelVersion)

Version number of the text detection model that was used to detect text.

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

Parameters:

textModelVersion -

Version number of the text detection model that was used to detect text.

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