Class DescribeUserResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeUserResponse.Builder,
DescribeUserResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DescribeUserResponse.Builder
builder()
final String
city()
City where the user is located.final String
company()
Company of the user.final String
country()
Country where the user is located.final String
Department of the user.final Instant
The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.final String
The display name of the user.final String
email()
The email of the user.final Instant
The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
First name of the user.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Boolean
If enabled, the user is hidden from the global address list.final String
initials()
Initials of the user.final String
jobTitle()
Job title of the user.final String
lastName()
Last name of the user.final Instant
The date when the mailbox was removed for the user.final Instant
The date when the mailbox was created for the user.final String
name()
The name for the user.final String
office()
Office where the user is located.static Class
<? extends DescribeUserResponse.Builder> final EntityState
state()
The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).final String
The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).final String
street()
Street where the user is located.final String
User's contact number.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userId()
The identifier for the described user.final UserRole
userRole()
In certain cases, other entities are modeled as users.final String
In certain cases, other entities are modeled as users.final String
zipCode()
Zip code of the user.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userId
The identifier for the described user.
- Returns:
- The identifier for the described user.
-
name
The name for the user.
- Returns:
- The name for the user.
-
email
The email of the user.
- Returns:
- The email of the user.
-
displayName
The display name of the user.
- Returns:
- The display name of the user.
-
state
The state of a user: enabled (registered to 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 returnEntityState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
- See Also:
-
stateAsString
The state of a user: enabled (registered to 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 returnEntityState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
- See Also:
-
userRole
In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into 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, SYSTEM_USER, and REMOTE_USER.
If the service returns an enum value that is not available in the current SDK version,
userRole
will returnUserRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuserRoleAsString()
.- Returns:
- In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into 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, SYSTEM_USER, and REMOTE_USER.
- See Also:
-
userRoleAsString
In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into 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, SYSTEM_USER, and REMOTE_USER.
If the service returns an enum value that is not available in the current SDK version,
userRole
will returnUserRole.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuserRoleAsString()
.- Returns:
- In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into 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, SYSTEM_USER, and REMOTE_USER.
- See Also:
-
enabledDate
The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.
- Returns:
- The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.
-
disabledDate
The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.
- Returns:
- The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.
-
mailboxProvisionedDate
The date when the mailbox was created for the user.
- Returns:
- The date when the mailbox was created for the user.
-
mailboxDeprovisionedDate
The date when the mailbox was removed for the user.
- Returns:
- The date when the mailbox was removed for the user.
-
firstName
First name of the user.
- Returns:
- First name of the user.
-
lastName
Last name of the user.
- Returns:
- Last name of the user.
-
initials
Initials of the user.
- Returns:
- Initials of the user.
-
telephone
User's contact number.
- Returns:
- User's contact number.
-
street
Street where the user is located.
- Returns:
- Street where the user is located.
-
jobTitle
Job title of the user.
- Returns:
- Job title of the user.
-
city
City where the user is located.
- Returns:
- City where the user is located.
-
company
Company of the user.
- Returns:
- Company of the user.
-
zipCode
Zip code of the user.
- Returns:
- Zip code of the user.
-
department
Department of the user.
- Returns:
- Department of the user.
-
country
Country where the user is located.
- Returns:
- Country where the user is located.
-
office
Office where the user is located.
- Returns:
- Office where the user is located.
-
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 interfaceToCopyableBuilder<DescribeUserResponse.Builder,
DescribeUserResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-