Class UpdateUserRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateUserRequest.Builder,
UpdateUserRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Amazon WorkDocs authentication token.static UpdateUserRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
The given name of the user.final BooleanEnumType
Boolean value to determine whether the user is granted Power user privileges.final String
Boolean value to determine whether the user is granted Power user privileges.final int
hashCode()
final LocaleType
locale()
The locale of the user.final String
The locale of the user.static Class
<? extends UpdateUserRequest.Builder> final StorageRuleType
The amount of storage for the user.final String
surname()
The surname of the user.final String
The time zone ID of the user.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 UserType
type()
The type of the user.final String
The type of the user.final String
userId()
The ID of the user.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
authenticationToken
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
- Returns:
- Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
-
userId
The ID of the user.
- Returns:
- The ID of the user.
-
givenName
The given name of the user.
- Returns:
- The given name of the user.
-
surname
The surname of the user.
- Returns:
- The surname of the user.
-
type
The type of the user.
If the service returns an enum value that is not available in the current SDK version,
type
will returnUserType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the user.
- See Also:
-
typeAsString
The type of the user.
If the service returns an enum value that is not available in the current SDK version,
type
will returnUserType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the user.
- See Also:
-
storageRule
The amount of storage for the user.
- Returns:
- The amount of storage for the user.
-
timeZoneId
The time zone ID of the user.
- Returns:
- The time zone ID of the user.
-
locale
The locale of the user.
If the service returns an enum value that is not available in the current SDK version,
locale
will returnLocaleType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocaleAsString()
.- Returns:
- The locale of the user.
- See Also:
-
localeAsString
The locale of the user.
If the service returns an enum value that is not available in the current SDK version,
locale
will returnLocaleType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocaleAsString()
.- Returns:
- The locale of the user.
- See Also:
-
grantPoweruserPrivileges
Boolean value to determine whether the user is granted Power user privileges.
If the service returns an enum value that is not available in the current SDK version,
grantPoweruserPrivileges
will returnBooleanEnumType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgrantPoweruserPrivilegesAsString()
.- Returns:
- Boolean value to determine whether the user is granted Power user privileges.
- See Also:
-
grantPoweruserPrivilegesAsString
Boolean value to determine whether the user is granted Power user privileges.
If the service returns an enum value that is not available in the current SDK version,
grantPoweruserPrivileges
will returnBooleanEnumType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgrantPoweruserPrivilegesAsString()
.- Returns:
- Boolean value to determine whether the user is granted Power user privileges.
- See Also:
-
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 classWorkDocsRequest
- 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
-