com.amazonaws.services.cognitoidentityprovider.model

Class GetUserResult

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.GetUserResult

All Implemented Interfaces:

Serializable

public class GetUserResult
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetUserResult()

Method Summary

Modifier and Type	Method and Description
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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetUserResult

public GetUserResult()

Method Detail

getUsername

public String getUsername()

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

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

setUsername

public void setUsername(String username)

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

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.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getUserAttributes

public List<AttributeType> getUserAttributes()

An array of name-value pairs representing user attributes.

Returns:

An array of name-value pairs representing user attributes.

setUserAttributes

public void setUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

Parameters:

userAttributes -

An array of name-value pairs representing user attributes.

withUserAttributes

public GetUserResult withUserAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

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

Parameters:

userAttributes -

An array of name-value pairs representing user attributes.

Returns:

A reference to this updated 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.

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

Parameters:

userAttributes -

An array of name-value pairs representing user attributes.

Returns:

A reference to this updated 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).

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

Parameters:

mFAOptions -

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

Returns:

A reference to this updated 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).

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

Parameters:

mFAOptions -

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

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object