Class User

java.lang.Object
software.amazon.awssdk.services.appstream.model.User
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<User.Builder,User>
@Generated("software.amazon.awssdk:codegen") public final class User extends Object implements SdkPojo, Serializable, ToCopyableBuilder<User.Builder,User>

Describes a user in the user pool.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the user.

      Returns:
      The ARN of the user.

    • userName

      public final String userName()

      The email address of the user.

      Users' email addresses are case-sensitive.

      Returns:
      The email address of the user.

      Users' email addresses are case-sensitive.

    • enabled

      public final Boolean enabled()

      Specifies whether the user in the user pool is enabled.

      Returns:
      Specifies whether the user in the user pool is enabled.

    • status

      public final String status()

      The status of the user in the user pool. The status can be one of the following:

      • UNCONFIRMED – The user is created but not confirmed.

      • CONFIRMED – The user is confirmed.

      • ARCHIVED – The user is no longer active.

      • COMPROMISED – The user is disabled because of a potential security threat.

      • UNKNOWN – The user status is not known.

      Returns:
      The status of the user in the user pool. The status can be one of the following:

      • UNCONFIRMED – The user is created but not confirmed.

      • CONFIRMED – The user is confirmed.

      • ARCHIVED – The user is no longer active.

      • COMPROMISED – The user is disabled because of a potential security threat.

      • UNKNOWN – The user status is not known.

    • firstName

      public final String firstName()

      The first name, or given name, of the user.

      Returns:
      The first name, or given name, of the user.

    • lastName

      public final String lastName()

      The last name, or surname, of the user.

      Returns:
      The last name, or surname, of the user.

    • createdTime

      public final Instant createdTime()

      The date and time the user was created in the user pool.

      Returns:
      The date and time the user was created in the user pool.

    • authenticationType

      public final AuthenticationType authenticationType()

      The authentication type for the user.

      If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

      Returns:
      The authentication type for the user.
      See Also:

    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      The authentication type for the user.

      If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

      Returns:
      The authentication type for the user.
      See Also:

    • toBuilder

      public User.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<User.Builder,User>
      Returns:
      a builder for type T

    • builder

      public static User.Builder builder()

    • serializableBuilderClass

      public static Class<? extends User.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.