Class User

java.lang.Object
software.amazon.awssdk.services.directoryservicedata.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>

A user object that contains identifying information and attributes for a specified user.

See Also:

  • Method Details

    • distinguishedName

      public final String distinguishedName()

      The distinguished name of the object.

      Returns:
      The distinguished name of the object.

    • emailAddress

      public final String emailAddress()

      The email address of the user.

      Returns:
      The email address of the user.

    • enabled

      public final Boolean enabled()

      Indicates whether the user account is active.

      Returns:
      Indicates whether the user account is active.

    • givenName

      public final String givenName()

      The first name of the user.

      Returns:
      The first name of the user.

    • hasOtherAttributes

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

    • otherAttributes

      public final Map<String,AttributeValue> otherAttributes()

      An expression that includes one or more attributes, data types, and values of a user.

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

      Returns:
      An expression that includes one or more attributes, data types, and values of a user.

    • samAccountName

      public final String samAccountName()

      The name of the user.

      Returns:
      The name of the user.

    • sid

      public final String sid()

      The unique security identifier (SID) of the user.

      Returns:
      The unique security identifier (SID) of the user.

    • surname

      public final String surname()

      The last name of the user.

      Returns:
      The last name of the user.

    • userPrincipalName

      public final String userPrincipalName()

      The UPN that is an internet-style login name for a user and based on the internet standard RFC 822. The UPN is shorter than the distinguished name and easier to remember.

      Returns:
      The UPN that is an internet-style login name for a user and based on the internet standard RFC 822. The UPN is shorter than the distinguished name and easier to remember.

    • 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.