@Generated(value="software.amazon.awssdk:codegen") public final class GetUserResponse extends CognitoIdentityProviderResponse implements ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>
Represents the response from the server from the request to get information about the user.
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetUserResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetUserResponse.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasMfaOptions()
For responses, this returns true if the service returned a value for the MFAOptions property.
|
boolean |
hasUserAttributes()
For responses, this returns true if the service returned a value for the UserAttributes property.
|
boolean |
hasUserMFASettingList()
For responses, this returns true if the service returned a value for the UserMFASettingList property.
|
List<MFAOptionType> |
mfaOptions()
This response parameter is no longer supported. It provides information only about SMS MFA configurations.
|
String |
preferredMfaSetting()
The user's preferred MFA setting.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetUserResponse.Builder> |
serializableBuilderClass() |
GetUserResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<AttributeType> |
userAttributes()
An array of name-value pairs representing user attributes.
|
List<String> |
userMFASettingList()
The MFA options that are activated for the user.
|
String |
username()
The username of the user that you requested.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String username()
The username of the user that you requested.
public final boolean hasUserAttributes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AttributeType> userAttributes()
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom: prefix to the attribute name.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasUserAttributes() method.
For custom attributes, you must prepend the custom: prefix to the attribute name.
public final boolean hasMfaOptions()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<MFAOptionType> mfaOptions()
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasMfaOptions() method.
public final String preferredMfaSetting()
The user's preferred MFA setting.
public final boolean hasUserMFASettingList()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> userMFASettingList()
The MFA options that are activated for the user. The possible values in this list are SMS_MFA and
SOFTWARE_TOKEN_MFA.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasUserMFASettingList() method.
SMS_MFA and SOFTWARE_TOKEN_MFA.public GetUserResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>toBuilder in class AwsResponsepublic static GetUserResponse.Builder builder()
public static Class<? extends GetUserResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.