Package software.amazon.awssdk.services.rekognition.model

Class DetectTextResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DetectTextResponse.Builder,DetectTextResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DetectTextResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DetectTextResponse.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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DetectTextResponse.Builder>	serializableBuilderClass()
List<TextDetection>	textDetections()	An array of text that was detected in the input image.
String	textModelVersion()	The model version used to detect text.
DetectTextResponse.Builder	toBuilder()
String	toString()	Returns a string representation of 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

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<TextDetection> textDetections()

An array of text that was detected in the input image.

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 that was detected in the input image.

textModelVersion

public final String textModelVersion()

The model version used to detect text.

Returns:

The model version used to detect text.

toBuilder

public DetectTextResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectTextResponse.Builder,DetectTextResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DetectTextResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DetectTextResponse.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo