Class Face

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

Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

See Also:

  • Method Details

    • faceId

      public final String faceId()

      Unique identifier that Amazon Rekognition assigns to the face.

      Returns:
      Unique identifier that Amazon Rekognition assigns to the face.

    • boundingBox

      public final BoundingBox boundingBox()

      Bounding box of the face.

      Returns:
      Bounding box of the face.

    • imageId

      public final String imageId()

      Unique identifier that Amazon Rekognition assigns to the input image.

      Returns:
      Unique identifier that Amazon Rekognition assigns to the input image.

    • externalImageId

      public final String externalImageId()

      Identifier that you assign to all the faces in the input image.

      Returns:
      Identifier that you assign to all the faces in the input image.

    • confidence

      public final Float confidence()

      Confidence level that the bounding box contains a face (and not a different object such as a tree).

      Returns:
      Confidence level that the bounding box contains a face (and not a different object such as a tree).

    • indexFacesModelVersion

      public final String indexFacesModelVersion()

      The version of the face detect and storage model that was used when indexing the face vector.

      Returns:
      The version of the face detect and storage model that was used when indexing the face vector.

    • userId

      public final String userId()

      Unique identifier assigned to the user.

      Returns:
      Unique identifier assigned to the user.

    • toBuilder

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

    • builder

      public static Face.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.