Class DescribeUserResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.workmail.model.WorkMailResponse
software.amazon.awssdk.services.workmail.model.DescribeUserResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeUserResponse extends WorkMailResponse implements ToCopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>

  • Method Details

    • userId

      public final String userId()

      The identifier for the described user.

      Returns:
      The identifier for the described user.

    • name

      public final String name()

      The name for the user.

      Returns:
      The name for the user.

    • email

      public final String email()

      The email of the user.

      Returns:
      The email 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 a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

      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 a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

      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 a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
      See Also:

    • userRole

      public final UserRole userRole()

      In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_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:
      In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.
      See Also:

    • userRoleAsString

      public final String userRoleAsString()

      In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_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:
      In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.
      See Also:

    • enabledDate

      public final Instant enabledDate()

      The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

      Returns:
      The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

    • disabledDate

      public final Instant disabledDate()

      The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

      Returns:
      The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

    • mailboxProvisionedDate

      public final Instant mailboxProvisionedDate()

      The date when the mailbox was created for the user.

      Returns:
      The date when the mailbox was created for the user.

    • mailboxDeprovisionedDate

      public final Instant mailboxDeprovisionedDate()

      The date when the mailbox was removed for the user.

      Returns:
      The date when the mailbox was removed for the user.

    • firstName

      public final String firstName()

      First name of the user.

      Returns:
      First name of the user.

    • lastName

      public final String lastName()

      Last name of the user.

      Returns:
      Last name of the user.

    • hiddenFromGlobalAddressList

      public final Boolean hiddenFromGlobalAddressList()

      If enabled, the user is hidden from the global address list.

      Returns:
      If enabled, the user is hidden from the global address list.

    • initials

      public final String initials()

      Initials of the user.

      Returns:
      Initials of the user.

    • telephone

      public final String telephone()

      User's contact number.

      Returns:
      User's contact number.

    • street

      public final String street()

      Street where the user is located.

      Returns:
      Street where the user is located.

    • jobTitle

      public final String jobTitle()

      Job title of the user.

      Returns:
      Job title of the user.

    • city

      public final String city()

      City where the user is located.

      Returns:
      City where the user is located.

    • company

      public final String company()

      Company of the user.

      Returns:
      Company of the user.

    • zipCode

      public final String zipCode()

      Zip code of the user.

      Returns:
      Zip code of the user.

    • department

      public final String department()

      Department of the user.

      Returns:
      Department of the user.

    • country

      public final String country()

      Country where the user is located.

      Returns:
      Country where the user is located.

    • office

      public final String office()

      Office where the user is located.

      Returns:
      Office where the user is located.

    • toBuilder

      public DescribeUserResponse.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<DescribeUserResponse.Builder,DescribeUserResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeUserResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeUserResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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