CompareFacesResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.rekognition.model.CompareFacesResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CompareFacesResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

CompareFacesResult()

Constructors
Constructor and Description
`CompareFacesResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompareFacesResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<CompareFacesMatch>`	`getFaceMatches()` An array of faces in the target image that match the source image face.
`ComparedSourceImageFace`	`getSourceImageFace()` The face in the source image that was used for comparison.
`String`	`getSourceImageOrientationCorrection()` The value of `SourceImageOrientationCorrection` is always null.
`String`	`getTargetImageOrientationCorrection()` The value of `TargetImageOrientationCorrection` is always null.
`List<ComparedFace>`	`getUnmatchedFaces()` An array of faces in the target image that did not match the source image face.
`int`	`hashCode()`
`void`	`setFaceMatches(Collection<CompareFacesMatch> faceMatches)` An array of faces in the target image that match the source image face.
`void`	`setSourceImageFace(ComparedSourceImageFace sourceImageFace)` The face in the source image that was used for comparison.
`void`	`setSourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection)` The value of `SourceImageOrientationCorrection` is always null.
`void`	`setSourceImageOrientationCorrection(String sourceImageOrientationCorrection)` The value of `SourceImageOrientationCorrection` is always null.
`void`	`setTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection)` The value of `TargetImageOrientationCorrection` is always null.
`void`	`setTargetImageOrientationCorrection(String targetImageOrientationCorrection)` The value of `TargetImageOrientationCorrection` is always null.
`void`	`setUnmatchedFaces(Collection<ComparedFace> unmatchedFaces)` An array of faces in the target image that did not match the source image face.
`String`	`toString()` Returns a string representation of this object.
`CompareFacesResult`	`withFaceMatches(Collection<CompareFacesMatch> faceMatches)` An array of faces in the target image that match the source image face.
`CompareFacesResult`	`withFaceMatches(CompareFacesMatch... faceMatches)` An array of faces in the target image that match the source image face.
`CompareFacesResult`	`withSourceImageFace(ComparedSourceImageFace sourceImageFace)` The face in the source image that was used for comparison.
`CompareFacesResult`	`withSourceImageOrientationCorrection(OrientationCorrection sourceImageOrientationCorrection)` The value of `SourceImageOrientationCorrection` is always null.
`CompareFacesResult`	`withSourceImageOrientationCorrection(String sourceImageOrientationCorrection)` The value of `SourceImageOrientationCorrection` is always null.
`CompareFacesResult`	`withTargetImageOrientationCorrection(OrientationCorrection targetImageOrientationCorrection)` The value of `TargetImageOrientationCorrection` is always null.
`CompareFacesResult`	`withTargetImageOrientationCorrection(String targetImageOrientationCorrection)` The value of `TargetImageOrientationCorrection` is always null.
`CompareFacesResult`	`withUnmatchedFaces(Collection<ComparedFace> unmatchedFaces)` An array of faces in the target image that did not match the source image face.
`CompareFacesResult`	`withUnmatchedFaces(ComparedFace... unmatchedFaces)` An array of faces in the target image that did not match the source image face.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CompareFacesResult
```
public CompareFacesResult()
```
- Method Detail
  - setSourceImageFace
```
public void setSourceImageFace(ComparedSourceImageFace sourceImageFace)
```
    The face in the source image that was used for comparison.
    
    Parameters:
    
    sourceImageFace - The face in the source image that was used for comparison.
  - getSourceImageFace
```
public ComparedSourceImageFace getSourceImageFace()
```
    The face in the source image that was used for comparison.
    
    Returns:
    
    The face in the source image that was used for comparison.
  - withSourceImageFace
```
public CompareFacesResult withSourceImageFace(ComparedSourceImageFace sourceImageFace)
```
    The face in the source image that was used for comparison.
    
    Parameters:
    
    sourceImageFace - The face in the source image that was used for comparison.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFaceMatches
```
public List<CompareFacesMatch> getFaceMatches()
```
    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.
    
    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.
  - setFaceMatches
```
public void setFaceMatches(Collection<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.
    
    Parameters:
    
    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.
  - withFaceMatches
```
public CompareFacesResult withFaceMatches(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFaceMatches(java.util.Collection) or withFaceMatches(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFaceMatches
```
public CompareFacesResult withFaceMatches(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUnmatchedFaces
```
public List<ComparedFace> getUnmatchedFaces()
```
    An array of faces in the target image that did not match the source image face.
    
    Returns:
    
    An array of faces in the target image that did not match the source image face.
  - setUnmatchedFaces
```
public void setUnmatchedFaces(Collection<ComparedFace> unmatchedFaces)
```
    An array of faces in the target image that did not match the source image face.
    
    Parameters:
    
    unmatchedFaces - An array of faces in the target image that did not match the source image face.
  - withUnmatchedFaces
```
public CompareFacesResult withUnmatchedFaces(ComparedFace... unmatchedFaces)
```
    An array of faces in the target image that did not match the source image face.
    
    NOTE: This method appends the values to the existing list (if any). Use setUnmatchedFaces(java.util.Collection) or withUnmatchedFaces(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    unmatchedFaces - An array of faces in the target image that did not match the source image face.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUnmatchedFaces
```
public CompareFacesResult withUnmatchedFaces(Collection<ComparedFace> unmatchedFaces)
```
    An array of faces in the target image that did not match the source image face.
    
    Parameters:
    
    unmatchedFaces - An array of faces in the target image that did not match the source image face.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceImageOrientationCorrection
```
public void setSourceImageOrientationCorrection(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    OrientationCorrection
  - getSourceImageOrientationCorrection
```
public String getSourceImageOrientationCorrection()
```
    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.
    
    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
  - withSourceImageOrientationCorrection
```
public CompareFacesResult withSourceImageOrientationCorrection(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrientationCorrection
  - setSourceImageOrientationCorrection
```
public void setSourceImageOrientationCorrection(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.
    
    Parameters:
    
    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.
    
    See Also:
    
    OrientationCorrection
  - withSourceImageOrientationCorrection
```
public CompareFacesResult withSourceImageOrientationCorrection(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrientationCorrection
  - setTargetImageOrientationCorrection
```
public void setTargetImageOrientationCorrection(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    OrientationCorrection
  - getTargetImageOrientationCorrection
```
public String getTargetImageOrientationCorrection()
```
    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.
    
    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
  - withTargetImageOrientationCorrection
```
public CompareFacesResult withTargetImageOrientationCorrection(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrientationCorrection
  - setTargetImageOrientationCorrection
```
public void setTargetImageOrientationCorrection(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.
    
    Parameters:
    
    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.
    
    See Also:
    
    OrientationCorrection
  - withTargetImageOrientationCorrection
```
public CompareFacesResult withTargetImageOrientationCorrection(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrientationCorrection
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CompareFacesResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.556

Class CompareFacesResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

CompareFacesResult

Method Detail

setSourceImageFace

getSourceImageFace

withSourceImageFace

getFaceMatches

setFaceMatches

withFaceMatches

withFaceMatches

getUnmatchedFaces

setUnmatchedFaces

withUnmatchedFaces

withUnmatchedFaces

setSourceImageOrientationCorrection

getSourceImageOrientationCorrection

withSourceImageOrientationCorrection

setSourceImageOrientationCorrection

withSourceImageOrientationCorrection

setTargetImageOrientationCorrection

getTargetImageOrientationCorrection

withTargetImageOrientationCorrection

setTargetImageOrientationCorrection

withTargetImageOrientationCorrection

toString

equals

hashCode

clone