Class UserType

java.lang.Object
com.amazonaws.services.cognitoidp.model.UserType
All Implemented Interfaces:
Serializable, Cloneable

public class UserType extends Object implements Serializable, Cloneable

The user type.

See Also:
  • Constructor Details

    • UserType

      public UserType()
  • Method Details

    • setUsername

      public void setUsername(String username)

      The user name of the user you wish to describe.

      Parameters:
      username - The user name of the user you wish to describe.
    • getUsername

      public String getUsername()

      The user name of the user you wish to describe.

      Returns:
      The user name of the user you wish to describe.
    • withUsername

      public UserType withUsername(String username)

      The user name of the user you wish to describe.

      Parameters:
      username - The user name of the user you wish to describe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getAttributes

      public 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(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.

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

      Parameters:
      attributes - A container with information about the user type attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withAttributes

      public UserType withAttributes(Collection<AttributeType> attributes)

      A container with information about the user type attributes.

      Parameters:
      attributes - A container with information about the user type attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setUserCreateDate

      public void setUserCreateDate(Date userCreateDate)

      The creation date of the user.

      Parameters:
      userCreateDate - The creation date of the user.
    • getUserCreateDate

      public Date getUserCreateDate()

      The creation date of the user.

      Returns:
      The creation date of the user.
    • withUserCreateDate

      public UserType withUserCreateDate(Date userCreateDate)

      The creation date of the user.

      Parameters:
      userCreateDate - The creation date of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setUserLastModifiedDate

      public void setUserLastModifiedDate(Date userLastModifiedDate)

      The last modified date of the user.

      Parameters:
      userLastModifiedDate - The last modified date of the user.
    • getUserLastModifiedDate

      public Date getUserLastModifiedDate()

      The last modified date of the user.

      Returns:
      The last modified date of the user.
    • withUserLastModifiedDate

      public UserType withUserLastModifiedDate(Date userLastModifiedDate)

      The last modified date of the user.

      Parameters:
      userLastModifiedDate - The last modified date of the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setEnabled

      public void setEnabled(Boolean enabled)

      Specifies whether the user is enabled.

      Parameters:
      enabled - Specifies whether the user is enabled.
    • getEnabled

      public Boolean getEnabled()

      Specifies whether the user is enabled.

      Returns:
      Specifies whether the user is enabled.
    • withEnabled

      public UserType withEnabled(Boolean enabled)

      Specifies whether the user is enabled.

      Parameters:
      enabled - Specifies whether the user is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isEnabled

      public Boolean isEnabled()

      Specifies whether the user is enabled.

      Returns:
      Specifies whether the user 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:
    • 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:
    • withUserStatus

      public UserType 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:
    • 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:
    • withUserStatus

      public UserType 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:
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public UserType clone()
      Overrides:
      clone in class Object