UserType (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.18.31 API)

java.lang.Object
- software.amazon.awssdk.services.cognitoidentityprovider.model.UserType

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<UserType.Builder,UserType>

@Generated(value="software.amazon.awssdk:codegen")
public final class UserType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserType.Builder,UserType>

A user profile in a Amazon Cognito user pool.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UserType.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UserType.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AttributeType>`	`attributes()` A container with information about the user type attributes.
`static UserType.Builder`	`builder()`
`Boolean`	`enabled()` Specifies whether the user is enabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasMfaOptions()` For responses, this returns true if the service returned a value for the MFAOptions property.
`List<MFAOptionType>`	`mfaOptions()` The MFA options for the user.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UserType.Builder>`	`serializableBuilderClass()`
`UserType.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`userCreateDate()` The creation date of the user.
`Instant`	`userLastModifiedDate()` The last modified date of the user.
`String`	`username()` The user name of the user you want to describe.
`UserStatusType`	`userStatus()` The user status.
`String`	`userStatusAsString()` The user status.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - username
```
public final String username()
```
    The user name of the user you want to describe.
    
    Returns:
    
    The user name of the user you want to describe.
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attributes
```
public final List<AttributeType> attributes()
```
    A container with information about the user type attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.
    
    Returns:
    
    A container with information about the user type attributes.
  - userCreateDate
```
public final Instant userCreateDate()
```
    The creation date of the user.
    
    Returns:
    
    The creation date of the user.
  - userLastModifiedDate
```
public final Instant userLastModifiedDate()
```
    The last modified date of the user.
    
    Returns:
    
    The last modified date of the user.
  - enabled
```
public final Boolean enabled()
```
    Specifies whether the user is enabled.
    
    Returns:
    
    Specifies whether the user is enabled.
  - userStatus
```
public final 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.
    - ARCHIVED - User is no longer active.
    - 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.
    If the service returns an enum value that is not available in the current SDK version, userStatus will return UserStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userStatusAsString().
    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.
    
    ARCHIVED - User is no longer active.
    
    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
  - userStatusAsString
```
public final String userStatusAsString()
```
    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.
    - ARCHIVED - User is no longer active.
    - 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.
    If the service returns an enum value that is not available in the current SDK version, userStatus will return UserStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userStatusAsString().
    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.
    
    ARCHIVED - User is no longer active.
    
    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
  - hasMfaOptions
```
public final boolean hasMfaOptions()
```
    For responses, this returns true if the service returned a value for the MFAOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - mfaOptions
```
public final List<MFAOptionType> mfaOptions()
```
    The MFA options for the user.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMfaOptions() method.
    
    Returns:
    
    The MFA options for the user.
  - toBuilder
```
public UserType.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserType.Builder,UserType>
  - builder
```
public static UserType.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UserType.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UserType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

username

hasAttributes

attributes

userCreateDate

userLastModifiedDate

enabled

userStatus

userStatusAsString

hasMfaOptions

mfaOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields