java.lang.Object
- software.amazon.awssdk.services.rekognition.model.ComparedFace

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ComparedFace.Builder,ComparedFace>
```
@Generated("software.amazon.awssdk:codegen")
public final class ComparedFace
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ComparedFace.Builder,ComparedFace>
```
Provides face metadata for target image faces that are analyzed by CompareFaces and RecognizeCelebrities.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ComparedFace.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BoundingBox`	`boundingBox()`	Bounding box of the face.
`static ComparedFace.Builder`	`builder()`
`Float`	`confidence()`	Level of confidence that what the bounding box contains is a face.
`List<Emotion>`	`emotions()`	The emotions that appear to be expressed on the face, and the confidence level in the determination.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEmotions()`	For responses, this returns true if the service returned a value for the Emotions property.
`int`	`hashCode()`
`boolean`	`hasLandmarks()`	For responses, this returns true if the service returned a value for the Landmarks property.
`List<Landmark>`	`landmarks()`	An array of facial landmarks.
`Pose`	`pose()`	Indicates the pose of the face as determined by its pitch, roll, and yaw.
`ImageQuality`	`quality()`	Identifies face image brightness and sharpness.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ComparedFace.Builder>`	`serializableBuilderClass()`
`Smile`	`smile()`	Indicates whether or not the face is smiling, and the confidence level in the determination.
`ComparedFace.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - boundingBox
```
public final BoundingBox boundingBox()
```
    Bounding box of the face.
    
    Returns:
    
    Bounding box of the face.
  - confidence
```
public final Float confidence()
```
    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.
  - hasLandmarks
```
public final boolean hasLandmarks()
```
    For responses, this returns true if the service returned a value for the Landmarks 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.
  - landmarks
```
public final List<Landmark> landmarks()
```
    An array of facial landmarks.
    
    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 hasLandmarks() method.
    
    Returns:
    
    An array of facial landmarks.
  - pose
```
public final Pose pose()
```
    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.
  - quality
```
public final ImageQuality quality()
```
    Identifies face image brightness and sharpness.
    
    Returns:
    
    Identifies face image brightness and sharpness.
  - hasEmotions
```
public final boolean hasEmotions()
```
    For responses, this returns true if the service returned a value for the Emotions 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.
  - emotions
```
public final List<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".
    
    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 hasEmotions() method.
    
    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".
  - smile
```
public final Smile smile()
```
    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.
  - toBuilder
```
public ComparedFace.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ComparedFace.Builder,ComparedFace>
  - builder
```
public static ComparedFace.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ComparedFace.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ComparedFace

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

boundingBox

confidence

hasLandmarks

landmarks

pose

quality

hasEmotions

emotions

smile

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField