Class User
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<User.Builder,
User>
Describes a user.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic User.Builder
builder()
final Instant
The time when the user was created.final String
The email address of the user.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) final String
The given name of the user.final int
hashCode()
final String
id()
The ID of the user.final LocaleType
locale()
The locale of the user.final String
The locale of the user.final Instant
The time when the user was modified.final String
The ID of the organization.final String
The ID of the recycle bin folder.final String
The ID of the root folder.static Class
<? extends User.Builder> final UserStatusType
status()
The status of the user.final String
The status of the user.final UserStorageMetadata
storage()
The 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 user.final String
The type of user.final String
username()
The login name of the user.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the user.
- Returns:
- The ID of the user.
-
username
The login name of the user.
- Returns:
- The login name of the user.
-
emailAddress
The email address of the user.
- Returns:
- The email address 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.
-
organizationId
The ID of the organization.
- Returns:
- The ID of the organization.
-
rootFolderId
The ID of the root folder.
- Returns:
- The ID of the root folder.
-
recycleBinFolderId
The ID of the recycle bin folder.
- Returns:
- The ID of the recycle bin folder.
-
status
The status of the user.
If the service returns an enum value that is not available in the current SDK version,
status
will returnUserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the user.
- See Also:
-
statusAsString
The status of the user.
If the service returns an enum value that is not available in the current SDK version,
status
will returnUserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the user.
- See Also:
-
type
The type of 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 user.
- See Also:
-
typeAsString
The type of 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 user.
- See Also:
-
createdTimestamp
The time when the user was created.
- Returns:
- The time when the user was created.
-
modifiedTimestamp
The time when the user was modified.
- Returns:
- The time when the user was modified.
-
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:
-
storage
The storage for the user.
- Returns:
- The storage for the user.
-
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<User.Builder,
User> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-