Class User

java.lang.Object
software.amazon.awssdk.services.identitystore.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>

A user object that contains the metadata and attributes for a specified user.

See Also:

  • Method Details

    • identityStoreId

      public final String identityStoreId()

      The globally unique identifier for the identity store.

      Returns:
      The globally unique identifier for 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.

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

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

      An object containing the name of the user.

      Returns:
      An object containing the name of the user.

    • displayName

      public final String displayName()

      A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

      Prefix search supports a maximum of 1,000 characters for the string.

      Returns:
      A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

      Prefix search supports a maximum of 1,000 characters for the string.

    • nickName

      public final String nickName()

      A string containing an alternate name for the user.

      Returns:
      A string containing an alternate name for the user.

    • profileUrl

      public final String profileUrl()

      A string containing a URL that might be associated with the user.

      Returns:
      A string containing a URL that might be associated with the user.

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

      A list of Email objects containing email addresses associated with 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:
      A list of Email objects containing email addresses associated with 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()

      A list of Address objects containing addresses associated with 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:
      A list of Address objects containing addresses associated with 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 containing phone numbers associated with 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 hasPhoneNumbers() method.

      Returns:
      A list of PhoneNumber objects containing phone numbers associated with the user.

    • userType

      public final String userType()

      A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

      Returns:
      A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

    • title

      public final String title()

      A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

      Returns:
      A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

    • preferredLanguage

      public final String preferredLanguage()

      A string containing the preferred language of the user. For example, "American English" or "en-us."

      Returns:
      A string containing the preferred language of the user. For example, "American English" or "en-us."

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

      A string containing the time zone of the user.

      Returns:
      A string containing the time zone of the user.

    • userStatus

      public final UserStatus userStatus()

      The current status of the user account.

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

      Returns:
      The current status of the user account.
      See Also:

    • userStatusAsString

      public final String userStatusAsString()

      The current status of the user account.

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

      Returns:
      The current status of the user account.
      See Also:

    • hasPhotos

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

    • photos

      public final List<Photo> photos()

      A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

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

      Returns:
      A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

    • website

      public final String website()

      The user's personal website or blog URL. This field stores website information for personal or professional use.

      Returns:
      The user's personal website or blog URL. This field stores website information for personal or professional use.

    • birthdate

      public final String birthdate()

      The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.

      Returns:
      The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.

    • createdAt

      public final Instant createdAt()

      The date and time the user was created.

      Returns:
      The date and time the user was created.

    • createdBy

      public final String createdBy()

      The identifier of the user or system that created the user.

      Returns:
      The identifier of the user or system that created the user.

    • updatedAt

      public final Instant updatedAt()

      The date and time the user was last updated.

      Returns:
      The date and time the user was last updated.

    • updatedBy

      public final String updatedBy()

      The identifier of the user or system that last updated the user.

      Returns:
      The identifier of the user or system that last updated the user.

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