Package software.amazon.awssdk.services.rekognition.model

Class UnindexedFace

java.lang.Object
software.amazon.awssdk.services.rekognition.model.UnindexedFace
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UnindexedFace.Builder,UnindexedFace>
@Generated("software.amazon.awssdk:codegen") public final class UnindexedFace extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UnindexedFace.Builder,UnindexedFace>

A face that IndexFaces detected, but didn't index. Use the Reasons response attribute to determine why a face wasn't indexed.

See Also:

  • Method Details

    • reasons

      public final List<Reason> reasons()

      An array of reasons that specify why a face wasn't indexed.

      • EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.

      • EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces.

      • LOW_BRIGHTNESS - The image is too dark.

      • LOW_SHARPNESS - The image is too blurry.

      • LOW_CONFIDENCE - The face was detected with a low confidence.

      • SMALL_BOUNDING_BOX - The bounding box around the face is too small.

      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 hasReasons() method.

      Returns:
      An array of reasons that specify why a face wasn't indexed.

      • EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.

      • EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces.

      • LOW_BRIGHTNESS - The image is too dark.

      • LOW_SHARPNESS - The image is too blurry.

      • LOW_CONFIDENCE - The face was detected with a low confidence.

      • SMALL_BOUNDING_BOX - The bounding box around the face is too small.

    • hasReasons

      public final boolean hasReasons()
      For responses, this returns true if the service returned a value for the Reasons 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.

    • reasonsAsStrings

      public final List<String> reasonsAsStrings()

      An array of reasons that specify why a face wasn't indexed.

      • EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.

      • EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces.

      • LOW_BRIGHTNESS - The image is too dark.

      • LOW_SHARPNESS - The image is too blurry.

      • LOW_CONFIDENCE - The face was detected with a low confidence.

      • SMALL_BOUNDING_BOX - The bounding box around the face is too small.

      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 hasReasons() method.

      Returns:
      An array of reasons that specify why a face wasn't indexed.

      • EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.

      • EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces.

      • LOW_BRIGHTNESS - The image is too dark.

      • LOW_SHARPNESS - The image is too blurry.

      • LOW_CONFIDENCE - The face was detected with a low confidence.

      • SMALL_BOUNDING_BOX - The bounding box around the face is too small.

    • faceDetail

      public final FaceDetail faceDetail()

      The structure that contains attributes of a face that IndexFacesdetected, but didn't index.

      Returns:
      The structure that contains attributes of a face that IndexFacesdetected, but didn't index.

    • toBuilder

      public UnindexedFace.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<UnindexedFace.Builder,UnindexedFace>
      Returns:
      a builder for type T

    • builder

      public static UnindexedFace.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UnindexedFace.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.