ComparedFace (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rekognition.model.ComparedFace

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ComparedFace
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides face metadata for target image faces that are analyzed by CompareFaces and RecognizeCelebrities.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ComparedFace()

Constructors
Constructor and Description
`ComparedFace()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ComparedFace`	`clone()`
`boolean`	`equals(Object obj)`
`BoundingBox`	`getBoundingBox()` Bounding box of the face.
`Float`	`getConfidence()` Level of confidence that what the bounding box contains is a face.
`List<Emotion>`	`getEmotions()` The emotions that appear to be expressed on the face, and the confidence level in the determination.
`List<Landmark>`	`getLandmarks()` An array of facial landmarks.
`Pose`	`getPose()` Indicates the pose of the face as determined by its pitch, roll, and yaw.
`ImageQuality`	`getQuality()` Identifies face image brightness and sharpness.
`Smile`	`getSmile()` Indicates whether or not the face is smiling, and the confidence level in the determination.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBoundingBox(BoundingBox boundingBox)` Bounding box of the face.
`void`	`setConfidence(Float confidence)` Level of confidence that what the bounding box contains is a face.
`void`	`setEmotions(Collection<Emotion> emotions)` The emotions that appear to be expressed on the face, and the confidence level in the determination.
`void`	`setLandmarks(Collection<Landmark> landmarks)` An array of facial landmarks.
`void`	`setPose(Pose pose)` Indicates the pose of the face as determined by its pitch, roll, and yaw.
`void`	`setQuality(ImageQuality quality)` Identifies face image brightness and sharpness.
`void`	`setSmile(Smile smile)` Indicates whether or not the face is smiling, and the confidence level in the determination.
`String`	`toString()` Returns a string representation of this object.
`ComparedFace`	`withBoundingBox(BoundingBox boundingBox)` Bounding box of the face.
`ComparedFace`	`withConfidence(Float confidence)` Level of confidence that what the bounding box contains is a face.
`ComparedFace`	`withEmotions(Collection<Emotion> emotions)` The emotions that appear to be expressed on the face, and the confidence level in the determination.
`ComparedFace`	`withEmotions(Emotion... emotions)` The emotions that appear to be expressed on the face, and the confidence level in the determination.
`ComparedFace`	`withLandmarks(Collection<Landmark> landmarks)` An array of facial landmarks.
`ComparedFace`	`withLandmarks(Landmark... landmarks)` An array of facial landmarks.
`ComparedFace`	`withPose(Pose pose)` Indicates the pose of the face as determined by its pitch, roll, and yaw.
`ComparedFace`	`withQuality(ImageQuality quality)` Identifies face image brightness and sharpness.
`ComparedFace`	`withSmile(Smile smile)` Indicates whether or not the face is smiling, and the confidence level in the determination.

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

- Constructor Detail
  - ComparedFace
```
public ComparedFace()
```
- Method Detail
  - setBoundingBox
```
public void setBoundingBox(BoundingBox boundingBox)
```
    Bounding box of the face.
    
    Parameters:
    
    boundingBox - Bounding box of the face.
  - getBoundingBox
```
public BoundingBox getBoundingBox()
```
    Bounding box of the face.
    
    Returns:
    
    Bounding box of the face.
  - withBoundingBox
```
public ComparedFace withBoundingBox(BoundingBox boundingBox)
```
    Bounding box of the face.
    
    Parameters:
    
    boundingBox - Bounding box of the face.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfidence
```
public void setConfidence(Float confidence)
```
    Level of confidence that what the bounding box contains is a face.
    
    Parameters:
    
    confidence - Level of confidence that what the bounding box contains is a face.
  - getConfidence
```
public Float getConfidence()
```
    Level of confidence that what the bounding box contains is a face.
    
    Returns:
    
    Level of confidence that what the bounding box contains is a face.
  - withConfidence
```
public ComparedFace withConfidence(Float confidence)
```
    Level of confidence that what the bounding box contains is a face.
    
    Parameters:
    
    confidence - Level of confidence that what the bounding box contains is a face.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLandmarks
```
public List<Landmark> getLandmarks()
```
    An array of facial landmarks.
    
    Returns:
    
    An array of facial landmarks.
  - setLandmarks
```
public void setLandmarks(Collection<Landmark> landmarks)
```
    An array of facial landmarks.
    
    Parameters:
    
    landmarks - An array of facial landmarks.
  - withLandmarks
```
public ComparedFace withLandmarks(Landmark... landmarks)
```
    An array of facial landmarks.
    
    NOTE: This method appends the values to the existing list (if any). Use setLandmarks(java.util.Collection) or withLandmarks(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    landmarks - An array of facial landmarks.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLandmarks
```
public ComparedFace withLandmarks(Collection<Landmark> landmarks)
```
    An array of facial landmarks.
    
    Parameters:
    
    landmarks - An array of facial landmarks.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPose
```
public void setPose(Pose pose)
```
    Indicates the pose of the face as determined by its pitch, roll, and yaw.
    
    Parameters:
    
    pose - Indicates the pose of the face as determined by its pitch, roll, and yaw.
  - getPose
```
public Pose getPose()
```
    Indicates the pose of the face as determined by its pitch, roll, and yaw.
    
    Returns:
    
    Indicates the pose of the face as determined by its pitch, roll, and yaw.
  - withPose
```
public ComparedFace withPose(Pose pose)
```
    Indicates the pose of the face as determined by its pitch, roll, and yaw.
    
    Parameters:
    
    pose - Indicates the pose of the face as determined by its pitch, roll, and yaw.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQuality
```
public void setQuality(ImageQuality quality)
```
    Identifies face image brightness and sharpness.
    
    Parameters:
    
    quality - Identifies face image brightness and sharpness.
  - getQuality
```
public ImageQuality getQuality()
```
    Identifies face image brightness and sharpness.
    
    Returns:
    
    Identifies face image brightness and sharpness.
  - withQuality
```
public ComparedFace withQuality(ImageQuality quality)
```
    Identifies face image brightness and sharpness.
    
    Parameters:
    
    quality - Identifies face image brightness and sharpness.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEmotions
```
public List<Emotion> getEmotions()
```
    The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
    
    Returns:
    
    The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
  - setEmotions
```
public void setEmotions(Collection<Emotion> emotions)
```
    The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
    
    Parameters:
    
    emotions - The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
  - withEmotions
```
public ComparedFace withEmotions(Emotion... emotions)
```
    The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
    
    NOTE: This method appends the values to the existing list (if any). Use setEmotions(java.util.Collection) or withEmotions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    emotions - The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEmotions
```
public ComparedFace withEmotions(Collection<Emotion> emotions)
```
    The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
    
    Parameters:
    
    emotions - The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted", "Surprised", "Calm", "Unknown", and "Fear".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmile
```
public void setSmile(Smile smile)
```
    Indicates whether or not the face is smiling, and the confidence level in the determination.
    
    Parameters:
    
    smile - Indicates whether or not the face is smiling, and the confidence level in the determination.
  - getSmile
```
public Smile getSmile()
```
    Indicates whether or not the face is smiling, and the confidence level in the determination.
    
    Returns:
    
    Indicates whether or not the face is smiling, and the confidence level in the determination.
  - withSmile
```
public ComparedFace withSmile(Smile smile)
```
    Indicates whether or not the face is smiling, and the confidence level in the determination.
    
    Parameters:
    
    smile - Indicates whether or not the face is smiling, and the confidence level in the determination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 ComparedFace clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class ComparedFace

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComparedFace

Method Detail

setBoundingBox

getBoundingBox

withBoundingBox

setConfidence

getConfidence

withConfidence

getLandmarks

setLandmarks

withLandmarks

withLandmarks

setPose

getPose

withPose

setQuality

getQuality

withQuality

getEmotions

setEmotions

withEmotions

withEmotions

setSmile

getSmile

withSmile

toString

equals

hashCode

clone

marshall