software.amazon.awssdk.services.rekognition.model

Class GetTextDetectionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rekognition.model.RekognitionResponse

software.amazon.awssdk.services.rekognition.model.GetTextDetectionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetTextDetectionResponse.Builder,GetTextDetectionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetTextDetectionResponse
extends RekognitionResponse
implements ToCopyableBuilder<GetTextDetectionResponse.Builder,GetTextDetectionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetTextDetectionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetTextDetectionResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTextDetections() For responses, this returns true if the service returned a value for the TextDetections property.
VideoJobStatus	jobStatus() Current status of the text detection job.
String	jobStatusAsString() Current status of the text detection job.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends GetTextDetectionResponse.Builder>	serializableBuilderClass()
String	statusMessage() If the job fails, StatusMessage provides a descriptive error message.
List<TextDetectionResult>	textDetections() An array of text detected in the video.
String	textModelVersion() Version number of the text detection model that was used to detect text.
GetTextDetectionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VideoMetadata	videoMetadata() Returns the value of the VideoMetadata property for this object.

Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobStatus

public final VideoJobStatus jobStatus()

Current status of the text detection job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return VideoJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

Current status of the text detection job.

See Also:

VideoJobStatus

jobStatusAsString

public final String jobStatusAsString()

Current status of the text detection job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return VideoJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

Current status of the text detection job.

See Also:

VideoJobStatus

statusMessage

public final String statusMessage()

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

Returns:

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

videoMetadata

public final VideoMetadata videoMetadata()

Returns the value of the VideoMetadata property for this object.

Returns:

The value of the VideoMetadata property for this object.

hasTextDetections

public final boolean hasTextDetections()

For responses, this returns true if the service returned a value for the TextDetections property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

textDetections

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTextDetections() method.

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.

nextToken

public final 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:

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.

textModelVersion

public final String textModelVersion()

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.

toBuilder

public GetTextDetectionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetTextDetectionResponse.Builder,GetTextDetectionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetTextDetectionResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetTextDetectionResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo