Class User

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

The representation of an WorkMail user.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the user.

      Returns:
      The identifier of the user.

    • email

      public final String email()

      The email of the user.

      Returns:
      The email of the user.

    • name

      public final String name()

      The name of the user.

      Returns:
      The name of the user.

    • displayName

      public final String displayName()

      The display name of the user.

      Returns:
      The display name of the user.

    • state

      public final EntityState state()

      The state of the user, which can be ENABLED, DISABLED, or DELETED.

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

      Returns:
      The state of the user, which can be ENABLED, DISABLED, or DELETED.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the user, which can be ENABLED, DISABLED, or DELETED.

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

      Returns:
      The state of the user, which can be ENABLED, DISABLED, or DELETED.
      See Also:

    • userRole

      public final UserRole userRole()

      The role of the user.

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

      Returns:
      The role of the user.
      See Also:

    • userRoleAsString

      public final String userRoleAsString()

      The role of the user.

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

      Returns:
      The role of the user.
      See Also:

    • enabledDate

      public final Instant enabledDate()

      The date indicating when the user was enabled for WorkMail use.

      Returns:
      The date indicating when the user was enabled for WorkMail use.

    • disabledDate

      public final Instant disabledDate()

      The date indicating when the user was disabled from WorkMail use.

      Returns:
      The date indicating when the user was disabled from WorkMail use.

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