Package software.amazon.awssdk.services.workmail.model

Interface UpdateUserRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>, SdkBuilder<UpdateUserRequest.Builder,UpdateUserRequest>, SdkPojo, SdkRequest.Builder, WorkMailRequest.Builder
Enclosing class:
UpdateUserRequest
public static interface UpdateUserRequest.Builder extends WorkMailRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

  • Method Details

    • organizationId

      UpdateUserRequest.Builder organizationId(String organizationId)

      The identifier for the organization under which the user exists.

      Parameters:
      organizationId - The identifier for the organization under which the user exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      UpdateUserRequest.Builder userId(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • role

      UpdateUserRequest.Builder role(String role)

      Updates the user role.

      You cannot pass SYSTEM_USER or RESOURCE.

      Parameters:
      role - Updates the user role.

      You cannot pass SYSTEM_USER or RESOURCE.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • role

      UpdateUserRequest.Builder role(UserRole role)

      Updates the user role.

      You cannot pass SYSTEM_USER or RESOURCE.

      Parameters:
      role - Updates the user role.

      You cannot pass SYSTEM_USER or RESOURCE.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • displayName

      UpdateUserRequest.Builder displayName(String displayName)

      Updates the display name of the user.

      Parameters:
      displayName - Updates the display name of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firstName

      UpdateUserRequest.Builder firstName(String firstName)

      Updates the user's first name.

      Parameters:
      firstName - Updates the user's first name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastName

      UpdateUserRequest.Builder lastName(String lastName)

      Updates the user's last name.

      Parameters:
      lastName - Updates the user's last name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hiddenFromGlobalAddressList

      UpdateUserRequest.Builder hiddenFromGlobalAddressList(Boolean hiddenFromGlobalAddressList)

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

      Parameters:
      hiddenFromGlobalAddressList - If enabled, the user is hidden from the global address list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initials

      UpdateUserRequest.Builder initials(String initials)

      Updates the user's initials.

      Parameters:
      initials - Updates the user's initials.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • telephone

      UpdateUserRequest.Builder telephone(String telephone)

      Updates the user's contact details.

      Parameters:
      telephone - Updates the user's contact details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • street

      UpdateUserRequest.Builder street(String street)

      Updates the user's street address.

      Parameters:
      street - Updates the user's street address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobTitle

      UpdateUserRequest.Builder jobTitle(String jobTitle)

      Updates the user's job title.

      Parameters:
      jobTitle - Updates the user's job title.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • city

      UpdateUserRequest.Builder city(String city)

      Updates the user's city.

      Parameters:
      city - Updates the user's city.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • company

      UpdateUserRequest.Builder company(String company)

      Updates the user's company.

      Parameters:
      company - Updates the user's company.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • zipCode

      UpdateUserRequest.Builder zipCode(String zipCode)

      Updates the user's zipcode.

      Parameters:
      zipCode - Updates the user's zipcode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • department

      UpdateUserRequest.Builder department(String department)

      Updates the user's department.

      Parameters:
      department - Updates the user's department.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • country

      UpdateUserRequest.Builder country(String country)

      Updates the user's country.

      Parameters:
      country - Updates the user's country.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • office

      UpdateUserRequest.Builder office(String office)

      Updates the user's office.

      Parameters:
      office - Updates the user's office.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.