Class User

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

Metadata of the user stored in a collection.

See Also:

  • Method Details

    • userId

      public final String userId()

      A provided ID for the User. Unique within the collection.

      Returns:
      A provided ID for the User. Unique within the collection.

    • userStatus

      public final UserStatus userStatus()

      Communicates if the UserID has been updated with latest set of faces to be associated with the UserID.

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

      Returns:
      Communicates if the UserID has been updated with latest set of faces to be associated with the UserID.
      See Also:

    • userStatusAsString

      public final String userStatusAsString()

      Communicates if the UserID has been updated with latest set of faces to be associated with the UserID.

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

      Returns:
      Communicates if the UserID has been updated with latest set of faces to be associated with the UserID.
      See Also:

    • toBuilder

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

    • builder

      public static User.Builder builder()

    • serializableBuilderClass

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