software.amazon.awssdk.services.workdocs.model

Class User

java.lang.Object

software.amazon.awssdk.services.workdocs.model.User

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<User.Builder,User>

@Generated(value="software.amazon.awssdk:codegen")
public final class User
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<User.Builder,User>

Describes a user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	User.Builder

Method Summary

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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The ID of the user.

Returns:

The ID of the user.

username

public final String username()

The login name of the user.

Returns:

The login name of the user.

emailAddress

public final String emailAddress()

The email address of the user.

Returns:

The email address of the user.

givenName

public final String givenName()

The given name of the user.

Returns:

The given name of the user.

surname

public final String surname()

The surname of the user.

Returns:

The surname of the user.

organizationId

public final String organizationId()

The ID of the organization.

Returns:

The ID of the organization.

rootFolderId

public final String rootFolderId()

The ID of the root folder.

Returns:

The ID of the root folder.

recycleBinFolderId

public final String recycleBinFolderId()

The ID of the recycle bin folder.

Returns:

The ID of the recycle bin folder.

status

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

Returns:

The status of the user.

See Also:

UserStatusType

statusAsString

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

Returns:

The status of the user.

See Also:

UserStatusType

type

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

Returns:

The type of user.

See Also:

UserType

typeAsString

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

Returns:

The type of user.

See Also:

UserType

createdTimestamp

public final Instant createdTimestamp()

The time when the user was created.

Returns:

The time when the user was created.

modifiedTimestamp

public final Instant modifiedTimestamp()

The time when the user was modified.

Returns:

The time when the user was modified.

timeZoneId

public final String timeZoneId()

The time zone ID of the user.

Returns:

The time zone ID of the user.

locale

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

Returns:

The locale of the user.

See Also:

LocaleType

localeAsString

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

Returns:

The locale of the user.

See Also:

LocaleType

storage

public final UserStorageMetadata storage()

The storage for the user.

Returns:

The storage for the user.

toBuilder

public User.Builder 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 interface ToCopyableBuilder<User.Builder,User>

Returns:

a builder for type T

builder

public static User.Builder builder()

serializableBuilderClass

public static Class<? extends User.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.