Package software.amazon.awssdk.services.workmail.model

Class User

java.lang.Object

software.amazon.awssdk.services.workmail.model.User

All Implemented Interfaces:

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

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

The representation of an WorkMail user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	User.Builder

Method Summary

Modifier and Type	Method	Description
static User.Builder	builder()
Instant	disabledDate()	The date indicating when the user was disabled from WorkMail use.
String	displayName()	The display name of the user.
String	email()	The email of the user.
Instant	enabledDate()	The date indicating when the user was enabled for WorkMail use.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the user.
String	name()	The name of the user.
List<SdkField<?>>	sdkFields()
static Class<? extends User.Builder>	serializableBuilderClass()
EntityState	state()	The state of the user, which can be ENABLED, DISABLED, or DELETED.
String	stateAsString()	The state of the user, which can be ENABLED, DISABLED, or DELETED.
User.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UserRole	userRole()	The role of the user.
String	userRoleAsString()	The role of the user.

Methods inherited from class java.lang.Object

clone, finalize, 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 identifier of the user.

Returns:

The identifier of the user.

email

public final String email()

The email of the user.

Returns:

The email of the user.

name

public final String name()

The name of the user.

Returns:

The name of the user.

displayName

public final String displayName()

The display name of the user.

Returns:

The display name of the user.

state

public final EntityState state()

The state of the user, which can be ENABLED, DISABLED, or DELETED.

If the service returns an enum value that is not available in the current SDK version, state will return EntityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the user, which can be ENABLED, DISABLED, or DELETED.

See Also:

EntityState

stateAsString

public final String stateAsString()

The state of the user, which can be ENABLED, DISABLED, or DELETED.

If the service returns an enum value that is not available in the current SDK version, state will return EntityState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the user, which can be ENABLED, DISABLED, or DELETED.

See Also:

EntityState

userRole

public final UserRole userRole()

The role of the user.

If the service returns an enum value that is not available in the current SDK version, userRole will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userRoleAsString().

Returns:

The role of the user.

See Also:

UserRole

userRoleAsString

public final String userRoleAsString()

The role of the user.

If the service returns an enum value that is not available in the current SDK version, userRole will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userRoleAsString().

Returns:

The role of the user.

See Also:

UserRole

enabledDate

public final Instant enabledDate()

The date indicating when the user was enabled for WorkMail use.

Returns:

The date indicating when the user was enabled for WorkMail use.

disabledDate

public final Instant disabledDate()

The date indicating when the user was disabled from WorkMail use.

Returns:

The date indicating when the user was disabled from WorkMail use.

toBuilder

public User.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<User.Builder,User>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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