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:

ToCopyableBuilder<SearchFacesByImageResponse.Builder,SearchFacesByImageResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchFacesByImageResponse.Builder

Method Summary

Modifier and Type	Method and Description
static SearchFacesByImageResponse.Builder	builder()
boolean	equals(Object obj)
List<FaceMatch>	faceMatches() An array of faces that match the input face, along with the confidence in the match.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

searchedFaceBoundingBox

public 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 Float searchedFaceConfidence()

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

Returns:

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

faceMatches

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

Returns:

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

toBuilder

public SearchFacesByImageResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SearchFacesByImageResponse.Builder,SearchFacesByImageResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static SearchFacesByImageResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value