software.amazon.awssdk.services.rekognition.model

Class CompareFacesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CompareFacesResponse.Builder,CompareFacesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CompareFacesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CompareFacesResponse.Builder	builder()
boolean	equals(Object obj)
List<CompareFacesMatch>	faceMatches() An array of faces in the target image that match the source image face.
<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()
List<SdkField<?>>	sdkFields()
static Class<? extends CompareFacesResponse.Builder>	serializableBuilderClass()
ComparedSourceImageFace	sourceImageFace() The face in the source image that was used for comparison.
OrientationCorrection	sourceImageOrientationCorrection() The value of SourceImageOrientationCorrection is always null.
String	sourceImageOrientationCorrectionAsString() The value of SourceImageOrientationCorrection is always null.
OrientationCorrection	targetImageOrientationCorrection() The value of TargetImageOrientationCorrection is always null.
String	targetImageOrientationCorrectionAsString() The value of TargetImageOrientationCorrection is always null.
CompareFacesResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<ComparedFace>	unmatchedFaces() An array of faces in the target image that did not match the source image face.

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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

sourceImageFace

public ComparedSourceImageFace sourceImageFace()

The face in the source image that was used for comparison.

Returns:

The face in the source image that was used for comparison.

faceMatches

public List<CompareFacesMatch> faceMatches()

An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

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

Returns:

An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

unmatchedFaces

public List<ComparedFace> unmatchedFaces()

An array of faces in the target image that did not match the source image face.

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

Returns:

An array of faces in the target image that did not match the source image face.

sourceImageOrientationCorrection

public OrientationCorrection sourceImageOrientationCorrection()

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

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

Returns:

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

sourceImageOrientationCorrectionAsString

public String sourceImageOrientationCorrectionAsString()

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

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

Returns:

The value of SourceImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

targetImageOrientationCorrection

public OrientationCorrection targetImageOrientationCorrection()

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

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

Returns:

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

targetImageOrientationCorrectionAsString

public String targetImageOrientationCorrectionAsString()

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

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

Returns:

The value of TargetImageOrientationCorrection is always null.

If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

See Also:

OrientationCorrection

toBuilder

public CompareFacesResponse.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<CompareFacesResponse.Builder,CompareFacesResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static CompareFacesResponse.Builder builder()

serializableBuilderClass

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.