UserType (AWS SDK for Java

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>

The user type.

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)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasMfaOptions()` Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<MFAOptionType>`	`mfaOptions()` The MFA options for the user.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UserType.Builder>`	`serializableBuilderClass()`
`UserType.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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 wish to describe.
`UserStatusType`	`userStatus()` The user status.
`String`	`userStatusAsString()` The user status.

Methods inherited from class java.lang.Object
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 wish to describe.
    
    Returns:
    
    The user name of the user you wish to describe.
  - hasAttributes
```
public final boolean hasAttributes()
```
    Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasAttributes() to see if a value was sent in this field.
    
    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. 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.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her 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. 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.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her password to a new value before doing anything else.
    See Also:
    
    UserStatusType
  - userStatusAsString
```
public final String userStatusAsString()
```
    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.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her 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. 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.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her password to a new value before doing anything else.
    See Also:
    
    UserStatusType
  - hasMfaOptions
```
public final boolean hasMfaOptions()
```
    Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasMfaOptions() to see if a value was sent in this field.
    
    Returns:
    
    The MFA options for the user.
  - toBuilder
```
public UserType.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserType.Builder,UserType>
    
    Returns:
    
    a builder for type T
  - 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.15.66

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

Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.