software.amazon.awssdk.services.workmail.model

Class User

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<User.Builder,User>

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

The representation of an Amazon WorkMail user.

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	disabledDate() The date indicating when the user was disabled from Amazon 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 Amazon WorkMail use.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier of the user.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	name() The name of the user.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
UserRole	userRole() The role of the user.
String	userRoleAsString() The role 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 String id()

The identifier of the user.

Returns:

The identifier of the user.

email

public String email()

The email of the user.

Returns:

The email of the user.

name

public String name()

The name of the user.

Returns:

The name of the user.

displayName

public String displayName()

The display name of the user.

Returns:

The display name of the user.

state

public 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 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 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 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 Instant enabledDate()

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

Returns:

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

disabledDate

public Instant disabledDate()

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

Returns:

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.