@Generated(value="software.amazon.awssdk:codegen") public final class User extends Object implements SdkPojo, Serializable, ToCopyableBuilder<User.Builder,User>
Describes a user.
Modifier and Type | Class and Description |
---|---|
static interface |
User.Builder |
Modifier and Type | Method and Description |
---|---|
static User.Builder |
builder() |
Instant |
createdTimestamp()
The time when the user was created.
|
String |
emailAddress()
The email address of the user.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
givenName()
The given name of the user.
|
int |
hashCode() |
String |
id()
The ID of the user.
|
LocaleType |
locale()
The locale of the user.
|
String |
localeAsString()
The locale of the user.
|
Instant |
modifiedTimestamp()
The time when the user was modified.
|
String |
organizationId()
The ID of the organization.
|
String |
recycleBinFolderId()
The ID of the recycle bin folder.
|
String |
rootFolderId()
The ID of the root folder.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends User.Builder> |
serializableBuilderClass() |
UserStatusType |
status()
The status of the user.
|
String |
statusAsString()
The status of the user.
|
UserStorageMetadata |
storage()
The storage for the user.
|
String |
surname()
The surname of the user.
|
String |
timeZoneId()
The time zone ID of the user.
|
User.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
UserType |
type()
The type of user.
|
String |
typeAsString()
The type of user.
|
String |
username()
The login name of the user.
|
copy
public final String id()
The ID of the user.
public final String username()
The login name of the user.
public final String emailAddress()
The email address of the user.
public final String givenName()
The given name of the user.
public final String surname()
The surname of the user.
public final String organizationId()
The ID of the organization.
public final String rootFolderId()
The ID of the root folder.
public final String recycleBinFolderId()
The ID of the recycle bin folder.
public final UserStatusType status()
The status of the user.
If the service returns an enum value that is not available in the current SDK version, status
will
return UserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
UserStatusType
public final String statusAsString()
The status of the user.
If the service returns an enum value that is not available in the current SDK version, status
will
return UserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
UserStatusType
public final UserType type()
The type of user.
If the service returns an enum value that is not available in the current SDK version, type
will return
UserType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
UserType
public final String typeAsString()
The type of user.
If the service returns an enum value that is not available in the current SDK version, type
will return
UserType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeAsString()
.
UserType
public final Instant createdTimestamp()
The time when the user was created.
public final Instant modifiedTimestamp()
The time when the user was modified.
public final String timeZoneId()
The time zone ID of the user.
public final LocaleType locale()
The locale of the user.
If the service returns an enum value that is not available in the current SDK version, locale
will
return LocaleType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
localeAsString()
.
LocaleType
public final String localeAsString()
The locale of the user.
If the service returns an enum value that is not available in the current SDK version, locale
will
return LocaleType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
localeAsString()
.
LocaleType
public final UserStorageMetadata storage()
The storage for the user.
public User.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<User.Builder,User>
public static User.Builder builder()
public static Class<? extends User.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.