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

Class CompareFacesMatch

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

Provides information about a face in a target image that matches the source image face analyzed by CompareFaces. The Face property contains the bounding box of the face in the target image. The Similarity property is the confidence that the source image face matches the face in the bounding box.

See Also:

  • Method Details

    • similarity

      public final Float similarity()

      Level of confidence that the faces match.

      Returns:
      Level of confidence that the faces match.

    • face

      public final ComparedFace face()

      Provides face metadata (bounding box and confidence that the bounding box actually contains a face).

      Returns:
      Provides face metadata (bounding box and confidence that the bounding box actually contains a face).

    • toBuilder

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

    • builder

      public static CompareFacesMatch.Builder builder()

    • serializableBuilderClass

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