@Generated(value="software.amazon.awssdk:codegen") public class DescribeUserResponse extends WorkMailResponse implements ToCopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeUserResponse.Builder |
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
String |
name()
The name for the user.
|
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
Amazon WorkMail).
|
String |
stateString()
The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to
Amazon WorkMail).
|
DescribeUserResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
userId()
The identifier for the described user.
|
UserRole |
userRole()
In certain cases other entities are modeled as users.
|
String |
userRoleString()
In certain cases other entities are modeled as users.
|
copy
public String userId()
The identifier for the described user.
public String name()
The name for the user.
public String email()
The email of the user.
public String displayName()
The display name of the user.
public EntityState state()
The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon 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
stateString()
.
EntityState
public String stateString()
The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to Amazon 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
stateString()
.
EntityState
public 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 Amazon WorkMail organizations rely on different directory types, administrators can distinguish between a user that is not registered to Amazon WorkMail (is disabled and has a user role) and the administrative users of the directory. 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
userRoleString()
.
UserRole
public String userRoleString()
In certain cases other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different Amazon WorkMail organizations rely on different directory types, administrators can distinguish between a user that is not registered to Amazon WorkMail (is disabled and has a user role) and the administrative users of the directory. 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
userRoleString()
.
UserRole
public Instant enabledDate()
The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.
public Instant disabledDate()
The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.
public DescribeUserResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>
toBuilder
in class AwsResponse
public static DescribeUserResponse.Builder builder()
public static Class<? extends DescribeUserResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.