UserType (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.services.cognitoidentityprovider.model.UserType

All Implemented Interfaces:

java.io.Serializable
```
public class UserType
extends java.lang.Object
implements java.io.Serializable
```
A user profile in a Amazon Cognito user pool.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserType()

Constructors
Constructor and Description
`UserType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<AttributeType>`	`getAttributes()` A container with information about the user type attributes.
`java.lang.Boolean`	`getEnabled()` Specifies whether the user is enabled.
`java.util.List<MFAOptionType>`	`getMFAOptions()` The MFA options for the user.
`java.util.Date`	`getUserCreateDate()` The creation date of the user.
`java.util.Date`	`getUserLastModifiedDate()` The date and time, in ISO 8601 format, when the item was modified.
`java.lang.String`	`getUsername()` The user name of the user you want to describe.
`java.lang.String`	`getUserStatus()` The user status.
`int`	`hashCode()`
`java.lang.Boolean`	`isEnabled()` Specifies whether the user is enabled.
`void`	`setAttributes(java.util.Collection<AttributeType> attributes)` A container with information about the user type attributes.
`void`	`setEnabled(java.lang.Boolean enabled)` Specifies whether the user is enabled.
`void`	`setMFAOptions(java.util.Collection<MFAOptionType> mFAOptions)` The MFA options for the user.
`void`	`setUserCreateDate(java.util.Date userCreateDate)` The creation date of the user.
`void`	`setUserLastModifiedDate(java.util.Date userLastModifiedDate)` The date and time, in ISO 8601 format, when the item was modified.
`void`	`setUsername(java.lang.String username)` The user name of the user you want to describe.
`void`	`setUserStatus(java.lang.String userStatus)` The user status.
`void`	`setUserStatus(UserStatusType userStatus)` The user status.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UserType`	`withAttributes(AttributeType... attributes)` A container with information about the user type attributes.
`UserType`	`withAttributes(java.util.Collection<AttributeType> attributes)` A container with information about the user type attributes.
`UserType`	`withEnabled(java.lang.Boolean enabled)` Specifies whether the user is enabled.
`UserType`	`withMFAOptions(java.util.Collection<MFAOptionType> mFAOptions)` The MFA options for the user.
`UserType`	`withMFAOptions(MFAOptionType... mFAOptions)` The MFA options for the user.
`UserType`	`withUserCreateDate(java.util.Date userCreateDate)` The creation date of the user.
`UserType`	`withUserLastModifiedDate(java.util.Date userLastModifiedDate)` The date and time, in ISO 8601 format, when the item was modified.
`UserType`	`withUsername(java.lang.String username)` The user name of the user you want to describe.
`UserType`	`withUserStatus(java.lang.String userStatus)` The user status.
`UserType`	`withUserStatus(UserStatusType userStatus)` The user status.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserType
```
public UserType()
```
- Method Detail
  - getUsername
```
public java.lang.String getUsername()
```
    The user name of the user you want to describe.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The user name of the user you want to describe.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    The user name of the user you want to describe.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user you want to describe.
  - withUsername
```
public UserType withUsername(java.lang.String username)
```
    The user name of the user you want to describe.
    
    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 want to describe.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributes
```
public java.util.List<AttributeType> getAttributes()
```
    A container with information about the user type attributes.
    
    Returns:
    
    A container with information about the user type attributes.
  - setAttributes
```
public void setAttributes(java.util.Collection<AttributeType> attributes)
```
    A container with information about the user type attributes.
    
    Parameters:
    
    attributes -
    A container with information about the user type attributes.
  - withAttributes
```
public UserType withAttributes(AttributeType... attributes)
```
    A container with information about the user type attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributes -
    A container with information about the user type attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAttributes
```
public UserType withAttributes(java.util.Collection<AttributeType> attributes)
```
    A container with information about the user type attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributes -
    A container with information about the user type attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserCreateDate
```
public java.util.Date getUserCreateDate()
```
    The creation date of the user.
    
    Returns:
    
    The creation date of the user.
  - setUserCreateDate
```
public void setUserCreateDate(java.util.Date userCreateDate)
```
    The creation date of the user.
    
    Parameters:
    
    userCreateDate -
    The creation date of the user.
  - withUserCreateDate
```
public UserType withUserCreateDate(java.util.Date userCreateDate)
```
    The creation date of the user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userCreateDate -
    The creation date of the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserLastModifiedDate
```
public java.util.Date getUserLastModifiedDate()
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Returns:
    
    The date and time, in ISO 8601 format, when the item was modified.
  - setUserLastModifiedDate
```
public void setUserLastModifiedDate(java.util.Date userLastModifiedDate)
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Parameters:
    
    userLastModifiedDate -
    The date and time, in ISO 8601 format, when the item was modified.
  - withUserLastModifiedDate
```
public UserType withUserLastModifiedDate(java.util.Date userLastModifiedDate)
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userLastModifiedDate -
    The date and time, in ISO 8601 format, when the item was modified.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isEnabled
```
public java.lang.Boolean isEnabled()
```
    Specifies whether the user is enabled.
    
    Returns:
    
    Specifies whether the user is enabled.
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
    Specifies whether the user is enabled.
    
    Returns:
    
    Specifies whether the user is enabled.
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Specifies whether the user is enabled.
    
    Parameters:
    
    enabled -
    Specifies whether the user is enabled.
  - withEnabled
```
public UserType withEnabled(java.lang.Boolean enabled)
```
    Specifies whether the user is enabled.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    enabled -
    Specifies whether the user is enabled.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserStatus
```
public java.lang.String getUserStatus()
```
    The user status. This can be one of the following:
    - UNCONFIRMED - User has been created but not confirmed.
    - CONFIRMED - User has been confirmed.
    - EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    - UNKNOWN - User status isn't known.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    Constraints:
    Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD
    Returns:
    The user status. This can be one of the following:
    
    UNCONFIRMED - User has been created but not confirmed.
    
    CONFIRMED - User has been confirmed.
    
    EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    
    UNKNOWN - User status isn't known.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    
    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    See Also:
    
    UserStatusType
  - setUserStatus
```
public void setUserStatus(java.lang.String userStatus)
```
    The user status. This can be one of the following:
    - UNCONFIRMED - User has been created but not confirmed.
    - CONFIRMED - User has been confirmed.
    - EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    - UNKNOWN - User status isn't known.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    Constraints:
    Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD
    Parameters:
    userStatus -
    The user status. This can be one of the following:
    
    UNCONFIRMED - User has been created but not confirmed.
    
    CONFIRMED - User has been confirmed.
    
    EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    
    UNKNOWN - User status isn't known.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    
    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    See Also:
    
    UserStatusType
  - withUserStatus
```
public UserType withUserStatus(java.lang.String userStatus)
```
    The user status. This can be one of the following:
    - UNCONFIRMED - User has been created but not confirmed.
    - CONFIRMED - User has been confirmed.
    - EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    - UNKNOWN - User status isn't known.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD
    Parameters:
    userStatus -
    The user status. This can be one of the following:
    
    UNCONFIRMED - User has been created but not confirmed.
    
    CONFIRMED - User has been confirmed.
    
    EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    
    UNKNOWN - User status isn't known.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    
    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserStatusType
  - setUserStatus
```
public void setUserStatus(UserStatusType userStatus)
```
    The user status. This can be one of the following:
    - UNCONFIRMED - User has been created but not confirmed.
    - CONFIRMED - User has been confirmed.
    - EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    - UNKNOWN - User status isn't known.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    Constraints:
    Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD
    Parameters:
    userStatus -
    The user status. This can be one of the following:
    
    UNCONFIRMED - User has been created but not confirmed.
    
    CONFIRMED - User has been confirmed.
    
    EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    
    UNKNOWN - User status isn't known.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    
    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    See Also:
    
    UserStatusType
  - withUserStatus
```
public UserType withUserStatus(UserStatusType userStatus)
```
    The user status. This can be one of the following:
    - UNCONFIRMED - User has been created but not confirmed.
    - CONFIRMED - User has been confirmed.
    - EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    - UNKNOWN - User status isn't known.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    - FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: UNCONFIRMED, CONFIRMED, ARCHIVED, COMPROMISED, UNKNOWN, RESET_REQUIRED, FORCE_CHANGE_PASSWORD
    Parameters:
    userStatus -
    The user status. This can be one of the following:
    
    UNCONFIRMED - User has been created but not confirmed.
    
    CONFIRMED - User has been confirmed.
    
    EXTERNAL_PROVIDER - User signed in with a third-party IdP.
    
    UNKNOWN - User status isn't known.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
    
    FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserStatusType
  - getMFAOptions
```
public java.util.List<MFAOptionType> getMFAOptions()
```
    The MFA options for the user.
    
    Returns:
    
    The MFA options for the user.
  - setMFAOptions
```
public void setMFAOptions(java.util.Collection<MFAOptionType> mFAOptions)
```
    The MFA options for the user.
    
    Parameters:
    
    mFAOptions -
    The MFA options for the user.
  - withMFAOptions
```
public UserType withMFAOptions(MFAOptionType... mFAOptions)
```
    The MFA options for the user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    mFAOptions -
    The MFA options for the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withMFAOptions
```
public UserType withMFAOptions(java.util.Collection<MFAOptionType> mFAOptions)
```
    The MFA options for the user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    mFAOptions -
    The MFA options for the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class UserType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserType

Method Detail

getUsername

setUsername

withUsername

getAttributes

setAttributes

withAttributes

withAttributes

getUserCreateDate

setUserCreateDate

withUserCreateDate

getUserLastModifiedDate

setUserLastModifiedDate

withUserLastModifiedDate

isEnabled

getEnabled

setEnabled

withEnabled

getUserStatus

setUserStatus

withUserStatus

setUserStatus

withUserStatus

getMFAOptions

setMFAOptions

withMFAOptions

withMFAOptions

toString

hashCode

equals