Class UpdateUserRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateUserRequest.Builder,
UpdateUserRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UpdateUserRequest.Builder
builder()
final String
city()
Updates the user's city.final String
company()
Updates the user's company.final String
country()
Updates the user's country.final String
Updates the user's department.final String
Updates the display name of the user.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Updates the user's first name.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Boolean
If enabled, the user is hidden from the global address list.final String
initials()
Updates the user's initials.final String
jobTitle()
Updates the user's job title.final String
lastName()
Updates the user's last name.final String
office()
Updates the user's office.final String
The identifier for the organization under which the user exists.final UserRole
role()
Updates the user role.final String
Updates the user role.static Class
<? extends UpdateUserRequest.Builder> final String
street()
Updates the user's street address.final String
Updates the user's contact details.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userId()
The identifier for the user to be updated.final String
zipCode()
Updates the user's zipcode.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
organizationId
The identifier for the organization under which the user exists.
- Returns:
- The identifier for the organization under which the user exists.
-
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
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 returnUserRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromroleAsString()
.- Returns:
- Updates the user role.
You cannot pass SYSTEM_USER or RESOURCE.
- See Also:
-
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 returnUserRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromroleAsString()
.- Returns:
- Updates the user role.
You cannot pass SYSTEM_USER or RESOURCE.
- See Also:
-
displayName
Updates the display name of the user.
- Returns:
- Updates the display name of the user.
-
firstName
Updates the user's first name.
- Returns:
- Updates the user's first name.
-
lastName
Updates the user's last name.
- Returns:
- Updates the user's last name.
-
initials
Updates the user's initials.
- Returns:
- Updates the user's initials.
-
telephone
Updates the user's contact details.
- Returns:
- Updates the user's contact details.
-
street
Updates the user's street address.
- Returns:
- Updates the user's street address.
-
jobTitle
Updates the user's job title.
- Returns:
- Updates the user's job title.
-
city
Updates the user's city.
- Returns:
- Updates the user's city.
-
company
Updates the user's company.
- Returns:
- Updates the user's company.
-
zipCode
Updates the user's zipcode.
- Returns:
- Updates the user's zipcode.
-
department
Updates the user's department.
- Returns:
- Updates the user's department.
-
country
Updates the user's country.
- Returns:
- Updates the user's country.
-
office
Updates the user's office.
- Returns:
- Updates the user's office.
-
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 interfaceToCopyableBuilder<UpdateUserRequest.Builder,
UpdateUserRequest> - Specified by:
toBuilder
in classWorkMailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-