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

Class SearchUsersByImageResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchUsersByImageResponse.Builder,SearchUsersByImageResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchUsersByImageResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SearchUsersByImageResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	faceModelVersion()	Version number of the face detection model associated with the input collection CollectionId.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUnsearchedFaces()	For responses, this returns true if the service returned a value for the UnsearchedFaces property.
boolean	hasUserMatches()	For responses, this returns true if the service returned a value for the UserMatches property.
List<SdkField<?>>	sdkFields()
SearchedFaceDetails	searchedFace()	A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches.
static Class<? extends SearchUsersByImageResponse.Builder>	serializableBuilderClass()
SearchUsersByImageResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<UnsearchedFace>	unsearchedFaces()	List of UnsearchedFace objects.
List<UserMatch>	userMatches()	An array of UserID objects that matched the input face, along with the confidence in the match.

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

hasUserMatches

public final boolean hasUserMatches()

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

userMatches

public final List<UserMatch> userMatches()

An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.

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

Returns:

An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.

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.

searchedFace

public final SearchedFaceDetails searchedFace()

A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.

Returns:

A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.

hasUnsearchedFaces

public final boolean hasUnsearchedFaces()

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

unsearchedFaces

public final List<UnsearchedFace> unsearchedFaces()

List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.

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

Returns:

List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.

toBuilder

public SearchUsersByImageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchUsersByImageResponse.Builder,SearchUsersByImageResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static SearchUsersByImageResponse.Builder builder()

serializableBuilderClass

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