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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateUserRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateUserRequest.Builder	builder()
String	city()	Updates the user's city.
String	company()	Updates the user's company.
String	country()	Updates the user's country.
String	department()	Updates the user's department.
String	displayName()	Updates the display name of the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firstName()	Updates the user's first name.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	hiddenFromGlobalAddressList()	If enabled, the user is hidden from the global address list.
String	identityProviderUserId()	User ID from the IAM Identity Center.
String	initials()	Updates the user's initials.
String	jobTitle()	Updates the user's job title.
String	lastName()	Updates the user's last name.
String	office()	Updates the user's office.
String	organizationId()	The identifier for the organization under which the user exists.
UserRole	role()	Updates the user role.
String	roleAsString()	Updates the user role.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateUserRequest.Builder>	serializableBuilderClass()
String	street()	Updates the user's street address.
String	telephone()	Updates the user's contact details.
UpdateUserRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The identifier for the user to be updated.
String	zipCode()	Updates the user's zip code.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

UserRole

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:

UserRole

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

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

Specified by:

toBuilder in class WorkMailRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo