Class UserIdentityInfo

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

Contains information about the identity of a user.

For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory.

See Also:

  • Method Details

    • firstName

      public final String firstName()

      The first name. This is required if you are using Amazon Connect or SAML for identity management.

      Returns:
      The first name. This is required if you are using Amazon Connect or SAML for identity management.

    • lastName

      public final String lastName()

      The last name. This is required if you are using Amazon Connect or SAML for identity management.

      Returns:
      The last name. This is required if you are using Amazon Connect or SAML for identity management.

    • email

      public final String email()

      The email address. If you are using SAML for identity management and include this parameter, an error is returned.

      Returns:
      The email address. If you are using SAML for identity management and include this parameter, an error is returned.

    • secondaryEmail

      public final String secondaryEmail()

      The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

      Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

      Returns:
      The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

      Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    • mobile

      public final String mobile()

      The user's mobile number.

      Returns:
      The user's mobile number.

    • toBuilder

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

    • builder

      public static UserIdentityInfo.Builder builder()

    • serializableBuilderClass

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