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

Class SearchFacesByImageResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchFacesByImageResponse.Builder,SearchFacesByImageResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchFacesByImageResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SearchFacesByImageResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FaceMatch>	faceMatches()	An array of faces that match the input face, along with the confidence in the match.
String	faceModelVersion()	Version number of the face detection model associated with the input collection (CollectionId).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFaceMatches()	For responses, this returns true if the service returned a value for the FaceMatches property.
int	hashCode()
List<SdkField<?>>	sdkFields()
BoundingBox	searchedFaceBoundingBox()	The bounding box around the face in the input image that Amazon Rekognition used for the search.
Float	searchedFaceConfidence()	The level of confidence that the searchedFaceBoundingBox, contains a face.
static Class<? extends SearchFacesByImageResponse.Builder>	serializableBuilderClass()
SearchFacesByImageResponse.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

searchedFaceBoundingBox

public final BoundingBox searchedFaceBoundingBox()

The bounding box around the face in the input image that Amazon Rekognition used for the search.

Returns:

The bounding box around the face in the input image that Amazon Rekognition used for the search.

searchedFaceConfidence

public final Float searchedFaceConfidence()

The level of confidence that the searchedFaceBoundingBox, contains a face.

Returns:

The level of confidence that the searchedFaceBoundingBox, contains a face.

hasFaceMatches

public final boolean hasFaceMatches()

For responses, this returns true if the service returned a value for the FaceMatches 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.

faceMatches

public final List<FaceMatch> faceMatches()

An array of faces that match the input face, along with the confidence in the match.

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 hasFaceMatches() method.

Returns:

An array of faces that match the input face, along with the confidence in the match.

faceModelVersion

public final String faceModelVersion()

Version number of the face detection model associated with the input collection (CollectionId).

Returns:

Version number of the face detection model associated with the input collection ( CollectionId).

toBuilder

public SearchFacesByImageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchFacesByImageResponse.Builder,SearchFacesByImageResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static SearchFacesByImageResponse.Builder builder()

serializableBuilderClass

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