software.amazon.awssdk.services.cognitoidentityprovider.model

Class GetUserResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.GetUserResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>

@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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetUserResponse.Builder

Method Summary

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() Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUserAttributes() Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUserMFASettingList() Returns true if the UserMFASettingList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 enabled for the user.
String	username() The user name of the user you wish to retrieve from the get user request.

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

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

username

public String username()

The user name of the user you wish to retrieve from the get user request.

Returns:

The user name of the user you wish to retrieve from the get user request.

hasUserAttributes

public boolean hasUserAttributes()

Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

userAttributes

public 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.

You can use hasUserAttributes() to see if a value was sent in this field.

Returns:

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

hasMfaOptions

public boolean hasMfaOptions()

Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

mfaOptions

public List<MFAOptionType> mfaOptions()

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the use the GetUserResponse$UserMFASettingList response instead.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasMfaOptions() to see if a value was sent in this field.

Returns:

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the use the GetUserResponse$UserMFASettingList response instead.

preferredMfaSetting

public String preferredMfaSetting()

The user's preferred MFA setting.

Returns:

The user's preferred MFA setting.

hasUserMFASettingList

public boolean hasUserMFASettingList()

Returns true if the UserMFASettingList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

userMFASettingList

public List<String> userMFASettingList()

The MFA options that are enabled 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.

You can use hasUserMFASettingList() to see if a value was sent in this field.

Returns:

The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

toBuilder

public GetUserResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetUserResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo