Class GetUserResult
- java.lang.Object
-
- com.amazonaws.services.cognitoidp.model.GetUserResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class GetUserResult extends Object implements Serializable, Cloneable
Represents the response from the server from the request to get information about the user.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description GetUserResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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(MFAOptionType... mFAOptions)
Specifies the options for MFA (e.g., email or phone number).GetUserResult
withMFAOptions(Collection<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.
-
-
-
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.
- 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.
NOTE: This method appends the values to the existing list (if any). Use
setUserAttributes(java.util.Collection)
orwithUserAttributes(java.util.Collection)
if you want to override the existing values.- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.- 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.
- Parameters:
userAttributes
- An array of name-value pairs representing user attributes.- 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)
orwithMFAOptions(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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public GetUserResult clone()
-
-