Class ComparedFace

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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ComparedFace.Builder,ComparedFace>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.