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

Class Gender

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

The predicted gender of a detected face.

Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor wearing a long-haired wig and earrings for a role might be predicted as female.

Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.

We don't recommend using gender binary predictions to make decisions that impact an individual's rights, privacy, or access to services.

See Also:

  • Method Details

    • value

      public final GenderType value()

      The predicted gender of the face.

      If the service returns an enum value that is not available in the current SDK version, value will return GenderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from valueAsString().

      Returns:
      The predicted gender of the face.
      See Also:

    • valueAsString

      public final String valueAsString()

      The predicted gender of the face.

      If the service returns an enum value that is not available in the current SDK version, value will return GenderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from valueAsString().

      Returns:
      The predicted gender of the face.
      See Also:

    • confidence

      public final Float confidence()

      Level of confidence in the prediction.

      Returns:
      Level of confidence in the prediction.

    • toBuilder

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

    • builder

      public static Gender.Builder builder()

    • serializableBuilderClass

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