User (AWS Java SDK :: Services :: Identitystore 2.21.17 API)

java.lang.Object
- software.amazon.awssdk.services.identitystore.model.User

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<User.Builder,User>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface User.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`User.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Address>`	`addresses()` A list of `Address` objects containing addresses associated with the user.
`static User.Builder`	`builder()`
`String`	`displayName()` A string containing the name of the user that is formatted for display when the user is referenced.
`List<Email>`	`emails()` A list of `Email` objects containing email addresses associated with the user.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ExternalId>`	`externalIds()` A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAddresses()` For responses, this returns true if the service returned a value for the Addresses property.
`boolean`	`hasEmails()` For responses, this returns true if the service returned a value for the Emails property.
`boolean`	`hasExternalIds()` For responses, this returns true if the service returned a value for the ExternalIds property.
`int`	`hashCode()`
`boolean`	`hasPhoneNumbers()` For responses, this returns true if the service returned a value for the PhoneNumbers property.
`String`	`identityStoreId()` The globally unique identifier for the identity store.
`String`	`locale()` A string containing the geographical region or location of the user.
`Name`	`name()` An object containing the name of the user.
`String`	`nickName()` A string containing an alternate name for the user.
`List<PhoneNumber>`	`phoneNumbers()` A list of `PhoneNumber` objects containing phone numbers associated with the user.
`String`	`preferredLanguage()` A string containing the preferred language of the user.
`String`	`profileUrl()` A string containing a URL that might be associated with the user.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends User.Builder>`	`serializableBuilderClass()`
`String`	`timezone()` A string containing the time zone of the user.
`String`	`title()` A string containing the title of the user.
`User.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userId()` The identifier for a user in the identity store.
`String`	`userName()` A unique string used to identify the user.
`String`	`userType()` A string indicating the type of user.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    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."
    
    Returns:
    
    A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."
  - 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.
  - identityStoreId
```
public final String identityStoreId()
```
    The globally unique identifier for the identity store.
    
    Returns:
    
    The globally unique identifier for the identity store.
  - toBuilder
```
public User.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<User.Builder,User>
  - 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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class User

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

userName

userId

hasExternalIds

externalIds

name

displayName

nickName

profileUrl

hasEmails

emails

hasAddresses

addresses

hasPhoneNumbers

phoneNumbers

userType

title

preferredLanguage

locale

timezone

identityStoreId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields