software.amazon.awssdk.services.workmail.model

Class DescribeUserResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.workmail.model.WorkMailResponse

software.amazon.awssdk.services.workmail.model.DescribeUserResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeUserResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeUserResponse.Builder	builder()
Instant	disabledDate() The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.
String	displayName() The display name of the user.
String	email() The email of the user.
Instant	enabledDate() The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name for the user.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeUserResponse.Builder>	serializableBuilderClass()
EntityState	state() The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).
String	stateAsString() The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).
DescribeUserResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userId() The identifier for the described user.
UserRole	userRole() In certain cases, other entities are modeled as users.
String	userRoleAsString() In certain cases, other entities are modeled as users.

Methods inherited from class software.amazon.awssdk.services.workmail.model.WorkMailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

userId

public final String userId()

The identifier for the described user.

Returns:

The identifier for the described user.

name

public final String name()

The name for the user.

Returns:

The name for the user.

email

public final String email()

The email of the user.

Returns:

The email 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 a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

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 a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

See Also:

EntityState

stateAsString

public final String stateAsString()

The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

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 a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

See Also:

EntityState

userRole

public final UserRole userRole()

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_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:

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.

See Also:

UserRole

userRoleAsString

public final String userRoleAsString()

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_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:

In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.

See Also:

UserRole

enabledDate

public final Instant enabledDate()

The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

Returns:

The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

disabledDate

public final Instant disabledDate()

The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

Returns:

The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

toBuilder

public DescribeUserResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeUserResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo