Package software.amazon.awssdk.services.identitystore.model

Class DescribeUserResponse

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

  • Method Details

    • userName

      public final String userName()

      A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

      Returns:
      A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

    • userId

      public final String userId()

      The identifier for a user in the identity store.

      Returns:
      The identifier for a user in the identity store.

    • hasExternalIds

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

    • externalIds

      public final List<ExternalId> externalIds()

      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

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

      Returns:
      A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

    • name

      public final Name name()

      The name of the user.

      Returns:
      The name of the user.

    • displayName

      public final String displayName()

      The display name of the user.

      Returns:
      The display name of the user.

    • nickName

      public final String nickName()

      An alternative descriptive name for the user.

      Returns:
      An alternative descriptive name for the user.

    • profileUrl

      public final String profileUrl()

      A URL link for the user's profile.

      Returns:
      A URL link for the user's profile.

    • hasEmails

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

    • emails

      public final List<Email> emails()

      The email address of 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 hasEmails() method.

      Returns:
      The email address of the user.

    • hasAddresses

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

    • addresses

      public final List<Address> addresses()

      The physical address of 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 hasAddresses() method.

      Returns:
      The physical address of the user.

    • hasPhoneNumbers

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

    • phoneNumbers

      public final List<PhoneNumber> phoneNumbers()

      A list of PhoneNumber objects associated with a 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 hasPhoneNumbers() method.

      Returns:
      A list of PhoneNumber objects associated with a user.

    • userType

      public final String userType()

      A string indicating the type of user.

      Returns:
      A string indicating the type of user.

    • title

      public final String title()

      A string containing the title of the user.

      Returns:
      A string containing the title of the user.

    • preferredLanguage

      public final String preferredLanguage()

      The preferred language of the user.

      Returns:
      The preferred language of the user.

    • locale

      public final String locale()

      A string containing the geographical region or location of the user.

      Returns:
      A string containing the geographical region or location of the user.

    • timezone

      public final String timezone()

      The time zone for a user.

      Returns:
      The time zone for a user.

    • identityStoreId

      public final String identityStoreId()

      The globally unique identifier for the identity store.

      Returns:
      The globally unique identifier for the identity store.

    • toBuilder

      public DescribeUserResponse.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<DescribeUserResponse.Builder,DescribeUserResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeUserResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeUserResponse.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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.