FaceDetail (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class FaceDetail
extends java.lang.Object
implements java.io.Serializable
```
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

Constructor Summary

Constructors
Constructor and Description

FaceDetail()

Constructors
Constructor and Description
`FaceDetail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`AgeRange`	`getAgeRange()` The estimated age range, in years, for the face.
`Beard`	`getBeard()` Indicates whether or not the face has a beard, and the confidence level in the determination.
`BoundingBox`	`getBoundingBox()` Bounding box of the face.
`java.lang.Float`	`getConfidence()` Confidence level that the bounding box contains a face (and not a different object such as a tree).
`java.util.List<Emotion>`	`getEmotions()` The emotions that appear to be expressed on the face, and the confidence level in the determination.
`Eyeglasses`	`getEyeglasses()` Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
`EyeOpen`	`getEyesOpen()` Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
`Gender`	`getGender()` The predicted gender of a detected face.
`java.util.List<Landmark>`	`getLandmarks()` Indicates the location of landmarks on the face.
`MouthOpen`	`getMouthOpen()` Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
`Mustache`	`getMustache()` Indicates whether or not the face has a mustache, and the confidence level in the determination.
`Pose`	`getPose()` Indicates the pose of the face as determined by its pitch, roll, and yaw.
`ImageQuality`	`getQuality()` Identifies image brightness and sharpness.
`Smile`	`getSmile()` Indicates whether or not the face is smiling, and the confidence level in the determination.
`Sunglasses`	`getSunglasses()` Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
`int`	`hashCode()`
`void`	`setAgeRange(AgeRange ageRange)` The estimated age range, in years, for the face.
`void`	`setBeard(Beard beard)` Indicates whether or not the face has a beard, and the confidence level in the determination.
`void`	`setBoundingBox(BoundingBox boundingBox)` Bounding box of the face.
`void`	`setConfidence(java.lang.Float confidence)` Confidence level that the bounding box contains a face (and not a different object such as a tree).
`void`	`setEmotions(java.util.Collection<Emotion> emotions)` The emotions that appear to be expressed on the face, and the confidence level in the determination.
`void`	`setEyeglasses(Eyeglasses eyeglasses)` Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
`void`	`setEyesOpen(EyeOpen eyesOpen)` Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
`void`	`setGender(Gender gender)` The predicted gender of a detected face.
`void`	`setLandmarks(java.util.Collection<Landmark> landmarks)` Indicates the location of landmarks on the face.
`void`	`setMouthOpen(MouthOpen mouthOpen)` Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
`void`	`setMustache(Mustache mustache)` Indicates whether or not the face has a mustache, and the confidence level in the determination.
`void`	`setPose(Pose pose)` Indicates the pose of the face as determined by its pitch, roll, and yaw.
`void`	`setQuality(ImageQuality quality)` Identifies image brightness and sharpness.
`void`	`setSmile(Smile smile)` Indicates whether or not the face is smiling, and the confidence level in the determination.
`void`	`setSunglasses(Sunglasses sunglasses)` Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`FaceDetail`	`withAgeRange(AgeRange ageRange)` The estimated age range, in years, for the face.
`FaceDetail`	`withBeard(Beard beard)` Indicates whether or not the face has a beard, and the confidence level in the determination.
`FaceDetail`	`withBoundingBox(BoundingBox boundingBox)` Bounding box of the face.
`FaceDetail`	`withConfidence(java.lang.Float confidence)` Confidence level that the bounding box contains a face (and not a different object such as a tree).
`FaceDetail`	`withEmotions(java.util.Collection<Emotion> emotions)` The emotions that appear to be expressed on the face, and the confidence level in the determination.
`FaceDetail`	`withEmotions(Emotion... emotions)` The emotions that appear to be expressed on the face, and the confidence level in the determination.
`FaceDetail`	`withEyeglasses(Eyeglasses eyeglasses)` Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
`FaceDetail`	`withEyesOpen(EyeOpen eyesOpen)` Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
`FaceDetail`	`withGender(Gender gender)` The predicted gender of a detected face.
`FaceDetail`	`withLandmarks(java.util.Collection<Landmark> landmarks)` Indicates the location of landmarks on the face.
`FaceDetail`	`withLandmarks(Landmark... landmarks)` Indicates the location of landmarks on the face.
`FaceDetail`	`withMouthOpen(MouthOpen mouthOpen)` Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
`FaceDetail`	`withMustache(Mustache mustache)` Indicates whether or not the face has a mustache, and the confidence level in the determination.
`FaceDetail`	`withPose(Pose pose)` Indicates the pose of the face as determined by its pitch, roll, and yaw.
`FaceDetail`	`withQuality(ImageQuality quality)` Identifies image brightness and sharpness.
`FaceDetail`	`withSmile(Smile smile)` Indicates whether or not the face is smiling, and the confidence level in the determination.
`FaceDetail`	`withSunglasses(Sunglasses sunglasses)` Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

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

- Constructor Detail
  - FaceDetail
```
public FaceDetail()
```
- Method Detail
  - getBoundingBox
```
public BoundingBox getBoundingBox()
```
    Bounding box of the face. Default attribute.
    
    Returns:
    
    Bounding box of the face. Default attribute.
  - setBoundingBox
```
public void setBoundingBox(BoundingBox boundingBox)
```
    Bounding box of the face. Default attribute.
    
    Parameters:
    
    boundingBox -
    Bounding box of the face. Default attribute.
  - withBoundingBox
```
public FaceDetail withBoundingBox(BoundingBox boundingBox)
```
    Bounding box of the face. Default attribute.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    boundingBox -
    Bounding box of the face. Default attribute.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAgeRange
```
public AgeRange getAgeRange()
```
    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.
  - setAgeRange
```
public void setAgeRange(AgeRange ageRange)
```
    The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
    
    Parameters:
    
    ageRange -
    The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
  - withAgeRange
```
public FaceDetail withAgeRange(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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    ageRange -
    The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withSmile
```
public FaceDetail withSmile(Smile smile)
```
    Indicates whether or not the face is smiling, and the confidence level in the determination.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    smile -
    Indicates whether or not the face is smiling, and the confidence level in the determination.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEyeglasses
```
public Eyeglasses getEyeglasses()
```
    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.
  - setEyeglasses
```
public void setEyeglasses(Eyeglasses eyeglasses)
```
    Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
    
    Parameters:
    
    eyeglasses -
    Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
  - withEyeglasses
```
public FaceDetail withEyeglasses(Eyeglasses eyeglasses)
```
    Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    eyeglasses -
    Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSunglasses
```
public Sunglasses getSunglasses()
```
    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.
  - setSunglasses
```
public void setSunglasses(Sunglasses sunglasses)
```
    Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
    
    Parameters:
    
    sunglasses -
    Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
  - withSunglasses
```
public FaceDetail withSunglasses(Sunglasses sunglasses)
```
    Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sunglasses -
    Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getGender
```
public Gender getGender()
```
    The predicted gender of a detected face.
    
    Returns:
    
    The predicted gender of a detected face.
  - setGender
```
public void setGender(Gender gender)
```
    The predicted gender of a detected face.
    
    Parameters:
    
    gender -
    The predicted gender of a detected face.
  - withGender
```
public FaceDetail withGender(Gender gender)
```
    The predicted gender of a detected face.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    gender -
    The predicted gender of a detected face.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getBeard
```
public Beard getBeard()
```
    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.
  - setBeard
```
public void setBeard(Beard beard)
```
    Indicates whether or not the face has a beard, and the confidence level in the determination.
    
    Parameters:
    
    beard -
    Indicates whether or not the face has a beard, and the confidence level in the determination.
  - withBeard
```
public FaceDetail withBeard(Beard beard)
```
    Indicates whether or not the face has a beard, and the confidence level in the determination.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    beard -
    Indicates whether or not the face has a beard, and the confidence level in the determination.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMustache
```
public Mustache getMustache()
```
    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.
  - setMustache
```
public void setMustache(Mustache mustache)
```
    Indicates whether or not the face has a mustache, and the confidence level in the determination.
    
    Parameters:
    
    mustache -
    Indicates whether or not the face has a mustache, and the confidence level in the determination.
  - withMustache
```
public FaceDetail withMustache(Mustache mustache)
```
    Indicates whether or not the face has a mustache, and the confidence level in the determination.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    mustache -
    Indicates whether or not the face has a mustache, and the confidence level in the determination.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEyesOpen
```
public EyeOpen getEyesOpen()
```
    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.
  - setEyesOpen
```
public void setEyesOpen(EyeOpen eyesOpen)
```
    Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
    
    Parameters:
    
    eyesOpen -
    Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
  - withEyesOpen
```
public FaceDetail withEyesOpen(EyeOpen eyesOpen)
```
    Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    eyesOpen -
    Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMouthOpen
```
public MouthOpen getMouthOpen()
```
    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.
  - setMouthOpen
```
public void setMouthOpen(MouthOpen mouthOpen)
```
    Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
    
    Parameters:
    
    mouthOpen -
    Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
  - withMouthOpen
```
public FaceDetail withMouthOpen(MouthOpen mouthOpen)
```
    Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    mouthOpen -
    Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEmotions
```
public java.util.List<Emotion> getEmotions()
```
    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.
    
    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.
  - setEmotions
```
public void setEmotions(java.util.Collection<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.
    
    Parameters:
    
    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.
  - withEmotions
```
public FaceDetail withEmotions(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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withEmotions
```
public FaceDetail withEmotions(java.util.Collection<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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLandmarks
```
public java.util.List<Landmark> getLandmarks()
```
    Indicates the location of landmarks on the face. Default attribute.
    
    Returns:
    
    Indicates the location of landmarks on the face. Default attribute.
  - setLandmarks
```
public void setLandmarks(java.util.Collection<Landmark> landmarks)
```
    Indicates the location of landmarks on the face. Default attribute.
    
    Parameters:
    
    landmarks -
    Indicates the location of landmarks on the face. Default attribute.
  - withLandmarks
```
public FaceDetail withLandmarks(Landmark... landmarks)
```
    Indicates the location of landmarks on the face. Default attribute.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    landmarks -
    Indicates the location of landmarks on the face. Default attribute.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withLandmarks
```
public FaceDetail withLandmarks(java.util.Collection<Landmark> landmarks)
```
    Indicates the location of landmarks on the face. Default attribute.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    landmarks -
    Indicates the location of landmarks on the face. Default attribute.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPose
```
public Pose getPose()
```
    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.
  - setPose
```
public void setPose(Pose pose)
```
    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
    
    Parameters:
    
    pose -
    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
  - withPose
```
public FaceDetail withPose(Pose pose)
```
    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    pose -
    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getQuality
```
public ImageQuality getQuality()
```
    Identifies image brightness and sharpness. Default attribute.
    
    Returns:
    
    Identifies image brightness and sharpness. Default attribute.
  - setQuality
```
public void setQuality(ImageQuality quality)
```
    Identifies image brightness and sharpness. Default attribute.
    
    Parameters:
    
    quality -
    Identifies image brightness and sharpness. Default attribute.
  - withQuality
```
public FaceDetail withQuality(ImageQuality quality)
```
    Identifies image brightness and sharpness. Default attribute.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    quality -
    Identifies image brightness and sharpness. Default attribute.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getConfidence
```
public java.lang.Float getConfidence()
```
    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
    
    Constraints:
    Length: 0 - 100
    
    Returns:
    
    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
  - setConfidence
```
public void setConfidence(java.lang.Float confidence)
```
    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
    
    Constraints:
    Length: 0 - 100
    
    Parameters:
    
    confidence -
    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
  - withConfidence
```
public FaceDetail withConfidence(java.lang.Float confidence)
```
    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 100
    
    Parameters:
    
    confidence -
    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class FaceDetail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FaceDetail

Method Detail

getBoundingBox

setBoundingBox

withBoundingBox

getAgeRange

setAgeRange

withAgeRange

getSmile

setSmile

withSmile

getEyeglasses

setEyeglasses

withEyeglasses

getSunglasses

setSunglasses

withSunglasses

getGender

setGender

withGender

getBeard

setBeard

withBeard

getMustache

setMustache

withMustache

getEyesOpen

setEyesOpen

withEyesOpen

getMouthOpen

setMouthOpen

withMouthOpen

getEmotions

setEmotions

withEmotions

withEmotions

getLandmarks

setLandmarks

withLandmarks

withLandmarks

getPose

setPose

withPose

getQuality

setQuality

withQuality

getConfidence

setConfidence

withConfidence

toString

hashCode

equals