com.amazonaws.services.cognitoidp.model

Class GetUserResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.cognitoidp.model.GetUserResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUserResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents the response from the server from the request to get information about the user.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetUserResult()

Method Summary

Modifier and Type	Method and Description
GetUserResult	clone()
boolean	equals(Object obj)
List<MFAOptionType>	getMFAOptions() Specifies the options for MFA (e.g., email or phone number).
List<AttributeType>	getUserAttributes() An array of name-value pairs representing user attributes.
String	getUsername() The user name of the user you wish to retrieve from the get user request.
int	hashCode()
void	setMFAOptions(Collection<MFAOptionType> mFAOptions) Specifies the options for MFA (e.g., email or phone number).
void	setUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
void	setUsername(String username) The user name of the user you wish to retrieve from the get user request.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetUserResult	withMFAOptions(Collection<MFAOptionType> mFAOptions) Specifies the options for MFA (e.g., email or phone number).
GetUserResult	withMFAOptions(MFAOptionType... mFAOptions) Specifies the options for MFA (e.g., email or phone number).
GetUserResult	withUserAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
GetUserResult	withUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
GetUserResult	withUsername(String username) The user name of the user you wish to retrieve from the get user request.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetUserResult

public GetUserResult()

Method Detail

setUsername

public void setUsername(String username)

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

Parameters:

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

getUsername

public String getUsername()

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.

withUsername

public GetUserResult withUsername(String username)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getUserAttributes

public List<AttributeType> getUserAttributes()

An array of name-value pairs representing user attributes.

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

Returns:

An array of name-value pairs representing user attributes.

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

setUserAttributes

public void setUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

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

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

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

withUserAttributes

public GetUserResult withUserAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

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

NOTE: This method appends the values to the existing list (if any). Use setUserAttributes(java.util.Collection) or withUserAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withUserAttributes

public GetUserResult withUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

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

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getMFAOptions

public List<MFAOptionType> getMFAOptions()

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

Returns:

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

setMFAOptions

public void setMFAOptions(Collection<MFAOptionType> mFAOptions)

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

Parameters:

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

withMFAOptions

public GetUserResult withMFAOptions(MFAOptionType... mFAOptions)

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

NOTE: This method appends the values to the existing list (if any). Use setMFAOptions(java.util.Collection) or withMFAOptions(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withMFAOptions

public GetUserResult withMFAOptions(Collection<MFAOptionType> mFAOptions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetUserResult clone()

Overrides:

clone in class Object