Class User

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

Contains information about a user account for an Amazon Connect instance.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the user account.

      Returns:
      The identifier of the user account.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the user account.

      Returns:
      The Amazon Resource Name (ARN) of the user account.

    • username

      public final String username()

      The user name assigned to the user account.

      Returns:
      The user name assigned to the user account.

    • identityInfo

      public final UserIdentityInfo identityInfo()

      Information about the user identity.

      Returns:
      Information about the user identity.

    • phoneConfig

      public final UserPhoneConfig phoneConfig()

      Information about the phone configuration for the user.

      Returns:
      Information about the phone configuration for the user.

    • directoryUserId

      public final String directoryUserId()

      The identifier of the user account in the directory used for identity management.

      Returns:
      The identifier of the user account in the directory used for identity management.

    • hasSecurityProfileIds

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

    • securityProfileIds

      public final List<String> securityProfileIds()

      The identifiers of the security profiles for 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 hasSecurityProfileIds() method.

      Returns:
      The identifiers of the security profiles for the user.

    • routingProfileId

      public final String routingProfileId()

      The identifier of the routing profile for the user.

      Returns:
      The identifier of the routing profile for the user.

    • hierarchyGroupId

      public final String hierarchyGroupId()

      The identifier of the hierarchy group for the user.

      Returns:
      The identifier of the hierarchy group for the user.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags.

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

      Returns:
      The tags.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when this resource was last modified.

      Returns:
      The timestamp when this resource was last modified.

    • lastModifiedRegion

      public final String lastModifiedRegion()

      The Amazon Web Services Region where this resource was last modified.

      Returns:
      The Amazon Web Services Region where this resource was last modified.

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