Class AdminGetUserResult
- java.lang.Object
-
- com.amazonaws.services.cognitoidp.model.AdminGetUserResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class AdminGetUserResult extends Object implements Serializable, Cloneable
Represents the response from the server from the request to get the specified user as an administrator.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AdminGetUserResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AdminGetUserResult
clone()
boolean
equals(Object obj)
Boolean
getEnabled()
Indicates that the status is enabled.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.Date
getUserCreateDate()
The date the user was created.Date
getUserLastModifiedDate()
The date the user was last modified.String
getUsername()
The user name of the user about whom you are receiving information.String
getUserStatus()
The user status.int
hashCode()
Boolean
isEnabled()
Indicates that the status is enabled.void
setEnabled(Boolean enabled)
Indicates that the status is enabled.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
setUserCreateDate(Date userCreateDate)
The date the user was created.void
setUserLastModifiedDate(Date userLastModifiedDate)
The date the user was last modified.void
setUsername(String username)
The user name of the user about whom you are receiving information.void
setUserStatus(UserStatusType userStatus)
The user status.void
setUserStatus(String userStatus)
The user status.String
toString()
Returns a string representation of this object; useful for testing and debugging.AdminGetUserResult
withEnabled(Boolean enabled)
Indicates that the status is enabled.AdminGetUserResult
withMFAOptions(MFAOptionType... mFAOptions)
Specifies the options for MFA (e.g., email or phone number).AdminGetUserResult
withMFAOptions(Collection<MFAOptionType> mFAOptions)
Specifies the options for MFA (e.g., email or phone number).AdminGetUserResult
withUserAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.AdminGetUserResult
withUserAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.AdminGetUserResult
withUserCreateDate(Date userCreateDate)
The date the user was created.AdminGetUserResult
withUserLastModifiedDate(Date userLastModifiedDate)
The date the user was last modified.AdminGetUserResult
withUsername(String username)
The user name of the user about whom you are receiving information.AdminGetUserResult
withUserStatus(UserStatusType userStatus)
The user status.AdminGetUserResult
withUserStatus(String userStatus)
The user status.
-
-
-
Method Detail
-
setUsername
public void setUsername(String username)
The user name of the user about whom you are receiving information.
- Parameters:
username
- The user name of the user about whom you are receiving information.
-
getUsername
public String getUsername()
The user name of the user about whom you are receiving information.
- Returns:
- The user name of the user about whom you are receiving information.
-
withUsername
public AdminGetUserResult withUsername(String username)
The user name of the user about whom you are receiving information.
- Parameters:
username
- The user name of the user about whom you are receiving information.- 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 AdminGetUserResult 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 AdminGetUserResult 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.
-
setUserCreateDate
public void setUserCreateDate(Date userCreateDate)
The date the user was created.
- Parameters:
userCreateDate
- The date the user was created.
-
getUserCreateDate
public Date getUserCreateDate()
The date the user was created.
- Returns:
- The date the user was created.
-
withUserCreateDate
public AdminGetUserResult withUserCreateDate(Date userCreateDate)
The date the user was created.
- Parameters:
userCreateDate
- The date the user was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUserLastModifiedDate
public void setUserLastModifiedDate(Date userLastModifiedDate)
The date the user was last modified.
- Parameters:
userLastModifiedDate
- The date the user was last modified.
-
getUserLastModifiedDate
public Date getUserLastModifiedDate()
The date the user was last modified.
- Returns:
- The date the user was last modified.
-
withUserLastModifiedDate
public AdminGetUserResult withUserLastModifiedDate(Date userLastModifiedDate)
The date the user was last modified.
- Parameters:
userLastModifiedDate
- The date the user was last modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEnabled
public void setEnabled(Boolean enabled)
Indicates that the status is enabled.
- Parameters:
enabled
- Indicates that the status is enabled.
-
getEnabled
public Boolean getEnabled()
Indicates that the status is enabled.
- Returns:
- Indicates that the status is enabled.
-
withEnabled
public AdminGetUserResult withEnabled(Boolean enabled)
Indicates that the status is enabled.
- Parameters:
enabled
- Indicates that the status is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEnabled
public Boolean isEnabled()
Indicates that the status is enabled.
- Returns:
- Indicates that the status is enabled.
-
setUserStatus
public void setUserStatus(String userStatus)
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Parameters:
userStatus
- The user status. Can be one of the following:- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- See Also:
UserStatusType
-
getUserStatus
public String getUserStatus()
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Returns:
- The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- See Also:
UserStatusType
-
withUserStatus
public AdminGetUserResult withUserStatus(String userStatus)
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Parameters:
userStatus
- The user status. Can be one of the following:- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
UserStatusType
-
setUserStatus
public void setUserStatus(UserStatusType userStatus)
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Parameters:
userStatus
- The user status. Can be one of the following:- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- See Also:
UserStatusType
-
withUserStatus
public AdminGetUserResult withUserStatus(UserStatusType userStatus)
The user status. Can be one of the following:
- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Parameters:
userStatus
- The user status. Can be one of the following:- UNCONFIRMED - User has been created but not confirmed.
- CONFIRMED - User has been confirmed.
- ARCHIVED - User is no longer active.
- COMPROMISED - User is disabled due to a potential security threat.
- UNKNOWN - User status is not known.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
UserStatusType
-
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 AdminGetUserResult 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 AdminGetUserResult 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 AdminGetUserResult clone()
-
-