@Generated(value="software.amazon.awssdk:codegen") public final class AdminGetUserResponse extends CognitoIdentityProviderResponse implements ToCopyableBuilder<AdminGetUserResponse.Builder,AdminGetUserResponse>
Represents the response from the server from the request to get the specified user as an administrator.
Modifier and Type | Class and Description |
---|---|
static interface |
AdminGetUserResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static AdminGetUserResponse.Builder |
builder() |
Boolean |
enabled()
Indicates that the status is enabled.
|
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() |
List<MFAOptionType> |
mfaOptions()
Specifies the options for MFA (e.g., email or phone number).
|
static Class<? extends AdminGetUserResponse.Builder> |
serializableBuilderClass() |
AdminGetUserResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<AttributeType> |
userAttributes()
An array of name-value pairs representing user attributes.
|
Instant |
userCreateDate()
The date the user was created.
|
Instant |
userLastModifiedDate()
The date the user was last modified.
|
String |
username()
The user name of the user about whom you are receiving information.
|
UserStatusType |
userStatus()
The user status.
|
String |
userStatusAsString()
The user status.
|
sdkHttpResponse
copy
public String username()
The user name of the user about whom you are receiving information.
public List<AttributeType> userAttributes()
An array of name-value pairs representing user attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Instant userCreateDate()
The date the user was created.
public Instant userLastModifiedDate()
The date the user was last modified.
public Boolean enabled()
Indicates that the status is enabled.
public UserStatusType userStatus()
The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
COMPROMISED - User is disabled due to a potential security threat.
UNKNOWN - User status is not known.
If the service returns an enum value that is not available in the current SDK version, userStatus
will
return UserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
userStatusAsString()
.
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
COMPROMISED - User is disabled due to a potential security threat.
UNKNOWN - User status is not known.
UserStatusType
public String userStatusAsString()
The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
COMPROMISED - User is disabled due to a potential security threat.
UNKNOWN - User status is not known.
If the service returns an enum value that is not available in the current SDK version, userStatus
will
return UserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
userStatusAsString()
.
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
COMPROMISED - User is disabled due to a potential security threat.
UNKNOWN - User status is not known.
UserStatusType
public List<MFAOptionType> mfaOptions()
Specifies the options for MFA (e.g., email or phone number).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public AdminGetUserResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AdminGetUserResponse.Builder,AdminGetUserResponse>
toBuilder
in class AwsResponse
public static AdminGetUserResponse.Builder builder()
public static Class<? extends AdminGetUserResponse.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.