Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class GetUserResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse
software.amazon.awssdk.services.cognitoidentityprovider.model.GetUserResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetUserResponse extends CognitoIdentityProviderResponse implements ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>

Represents the response from the server from the request to get information about the user.

  • Method Details

    • username

      public final String username()

      The name of the user that you requested.

      Returns:
      The name of the user that you requested.

    • hasUserAttributes

      public final boolean hasUserAttributes()
      For responses, this returns true if the service returned a value for the UserAttributes 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.

    • userAttributes

      public final List<AttributeType> userAttributes()

      An array of name-value pairs representing user attributes.

      Custom attributes are prepended with the custom: prefix.

      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 hasUserAttributes() method.

      Returns:
      An array of name-value pairs representing user attributes.

      Custom attributes are prepended with the custom: prefix.

    • 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()

      This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

      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:
      This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

    • preferredMfaSetting

      public final String preferredMfaSetting()

      The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.

      Returns:
      The user's preferred MFA. Users can prefer SMS message, email message, or TOTP MFA.

    • hasUserMFASettingList

      public final boolean hasUserMFASettingList()
      For responses, this returns true if the service returned a value for the UserMFASettingList 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.

    • userMFASettingList

      public final List<String> userMFASettingList()

      The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

      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 hasUserMFASettingList() method.

      Returns:
      The MFA options that are activated for the user. The possible values in this list are SMS_MFA, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

    • toBuilder

      public GetUserResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GetUserResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetUserResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo