FaceDetail (AWS Java SDK :: Services :: Amazon Rekognition 2.13.9 API)

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FaceDetail.Builder,FaceDetail>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class FaceDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FaceDetail.Builder,FaceDetail>
```
Structure containing attributes of the face that the algorithm detected.

A FaceDetail object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox, Confidence, Landmarks, Pose, and Quality.

GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a FaceDetail object with all attributes. To specify which attributes to return, use the FaceAttributes input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a FaceAttributes input parameter.
- GetCelebrityRecognition
- GetPersonTracking
- GetFaceSearch
The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To specify which attributes to return, use the Attributes input parameter for DetectFaces. For IndexFaces, use the DetectAttributes input parameter.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FaceDetail.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FaceDetail.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AgeRange`	`ageRange()` The estimated age range, in years, for the face.
`Beard`	`beard()` Indicates whether or not the face has a beard, and the confidence level in the determination.
`BoundingBox`	`boundingBox()` Bounding box of the face.
`static FaceDetail.Builder`	`builder()`
`Float`	`confidence()` Confidence level that the bounding box contains a face (and not a different object such as a tree).
`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)`
`Eyeglasses`	`eyeglasses()` Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
`EyeOpen`	`eyesOpen()` Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
`Gender`	`gender()` The predicted gender of a detected face.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEmotions()` Returns true if the Emotions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLandmarks()` Returns true if the Landmarks property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<Landmark>`	`landmarks()` Indicates the location of landmarks on the face.
`MouthOpen`	`mouthOpen()` Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
`Mustache`	`mustache()` Indicates whether or not the face has a mustache, and the confidence level in the determination.
`Pose`	`pose()` Indicates the pose of the face as determined by its pitch, roll, and yaw.
`ImageQuality`	`quality()` Identifies image brightness and sharpness.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FaceDetail.Builder>`	`serializableBuilderClass()`
`Smile`	`smile()` Indicates whether or not the face is smiling, and the confidence level in the determination.
`Sunglasses`	`sunglasses()` Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
`FaceDetail.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 BoundingBox boundingBox()
```
    Bounding box of the face. Default attribute.
    
    Returns:
    
    Bounding box of the face. Default attribute.
  - ageRange
```
public AgeRange ageRange()
```
    The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
    
    Returns:
    
    The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
  - smile
```
public 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.
  - eyeglasses
```
public Eyeglasses eyeglasses()
```
    Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
    
    Returns:
    
    Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
  - sunglasses
```
public Sunglasses sunglasses()
```
    Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
    
    Returns:
    
    Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
  - gender
```
public Gender gender()
```
    The predicted gender of a detected face.
    
    Returns:
    
    The predicted gender of a detected face.
  - beard
```
public Beard beard()
```
    Indicates whether or not the face has a beard, and the confidence level in the determination.
    
    Returns:
    
    Indicates whether or not the face has a beard, and the confidence level in the determination.
  - mustache
```
public Mustache mustache()
```
    Indicates whether or not the face has a mustache, and the confidence level in the determination.
    
    Returns:
    
    Indicates whether or not the face has a mustache, and the confidence level in the determination.
  - eyesOpen
```
public EyeOpen eyesOpen()
```
    Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
    
    Returns:
    
    Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
  - mouthOpen
```
public MouthOpen mouthOpen()
```
    Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
    
    Returns:
    
    Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
  - hasEmotions
```
public boolean hasEmotions()
```
    Returns true if the Emotions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - emotions
```
public List<Emotion> emotions()
```
    The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEmotions() to see if a value was sent in this field.
    
    Returns:
    
    The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
  - hasLandmarks
```
public boolean hasLandmarks()
```
    Returns true if the Landmarks property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - landmarks
```
public List<Landmark> landmarks()
```
    Indicates the location of landmarks on the face. Default attribute.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasLandmarks() to see if a value was sent in this field.
    
    Returns:
    
    Indicates the location of landmarks on the face. Default attribute.
  - pose
```
public Pose pose()
```
    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
    
    Returns:
    
    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
  - quality
```
public ImageQuality quality()
```
    Identifies image brightness and sharpness. Default attribute.
    
    Returns:
    
    Identifies image brightness and sharpness. Default attribute.
  - confidence
```
public Float confidence()
```
    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
    
    Returns:
    
    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
  - toBuilder
```
public FaceDetail.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FaceDetail.Builder,FaceDetail>
  - builder
```
public static FaceDetail.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FaceDetail.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class FaceDetail

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

ageRange

smile

eyeglasses

sunglasses

gender

beard

mustache

eyesOpen

mouthOpen

hasEmotions

emotions

hasLandmarks

landmarks

pose

quality

confidence

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields