Class UpdateUserRequest

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

  • Method Details

    • organizationId

      public final String organizationId()

      The identifier for the organization under which the user exists.

      Returns:
      The identifier for the organization under which the user exists.

    • userId

      public final String userId()

      The identifier for the user to be updated.

      The identifier can be the UserId, Username, or email. The following identity formats are available:

      • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: user@domain.tld

      • User name: user

      Returns:
      The identifier for the user to be updated.

      The identifier can be the UserId, Username, or email. The following identity formats are available:

      • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: user@domain.tld

      • User name: user

    • role

      public final UserRole role()

      Updates the user role.

      You cannot pass SYSTEM_USER or RESOURCE.

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

      Returns:
      Updates the user role.

      You cannot pass SYSTEM_USER or RESOURCE.

      See Also:

    • roleAsString

      public final String roleAsString()

      Updates the user role.

      You cannot pass SYSTEM_USER or RESOURCE.

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

      Returns:
      Updates the user role.

      You cannot pass SYSTEM_USER or RESOURCE.

      See Also:

    • displayName

      public final String displayName()

      Updates the display name of the user.

      Returns:
      Updates the display name of the user.

    • firstName

      public final String firstName()

      Updates the user's first name.

      Returns:
      Updates the user's first name.

    • lastName

      public final String lastName()

      Updates the user's last name.

      Returns:
      Updates the user's last name.

    • 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()

      Updates the user's initials.

      Returns:
      Updates the user's initials.

    • telephone

      public final String telephone()

      Updates the user's contact details.

      Returns:
      Updates the user's contact details.

    • street

      public final String street()

      Updates the user's street address.

      Returns:
      Updates the user's street address.

    • jobTitle

      public final String jobTitle()

      Updates the user's job title.

      Returns:
      Updates the user's job title.

    • city

      public final String city()

      Updates the user's city.

      Returns:
      Updates the user's city.

    • company

      public final String company()

      Updates the user's company.

      Returns:
      Updates the user's company.

    • zipCode

      public final String zipCode()

      Updates the user's zip code.

      Returns:
      Updates the user's zip code.

    • department

      public final String department()

      Updates the user's department.

      Returns:
      Updates the user's department.

    • country

      public final String country()

      Updates the user's country.

      Returns:
      Updates the user's country.

    • office

      public final String office()

      Updates the user's office.

      Returns:
      Updates the user's office.

    • identityProviderUserId

      public final String identityProviderUserId()

      User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

      Returns:
      User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

    • toBuilder

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

    • builder

      public static UpdateUserRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.