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)
<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).
String	preferredMfaSetting() The user's preferred MFA setting.
List<SdkField<?>>	sdkFields()
static Class<? extends GetUserResponse.Builder>	serializableBuilderClass()
GetUserResponse.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.
List<String>	userMFASettingList() The list of the user's MFA settings.
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

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.

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.

Returns:

An array of name-value pairs representing user attributes.

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

mfaOptions

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.

Returns:

Specifies the options for MFA (e.g., email or phone number).

preferredMfaSetting

public String preferredMfaSetting()

The user's preferred MFA setting.

Returns:

The user's preferred MFA setting.

userMFASettingList

public List<String> userMFASettingList()

The list of the user's MFA settings.

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

Returns:

The list of the user's MFA settings.

toBuilder

public GetUserResponse.Builder 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 interface ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetUserResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkResponse

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.