User (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.identitystore.model.User

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class User
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A user object that contains a specified user’s metadata and attributes.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`User`	`clone()`
`boolean`	`equals(Object obj)`
`List<Address>`	`getAddresses()` A list of `Address` objects containing addresses associated with the user.
`String`	`getDisplayName()` A string containing the user's name that's formatted for display when the user is referenced.
`List<Email>`	`getEmails()` A list of `Email` objects containing email addresses associated with the user.
`List<ExternalId>`	`getExternalIds()` A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.
`String`	`getIdentityStoreId()` The globally unique identifier for the identity store.
`String`	`getLocale()` A string containing the user's geographical region or location.
`Name`	`getName()` An object containing the user's name.
`String`	`getNickName()` A string containing an alternate name for the user.
`List<PhoneNumber>`	`getPhoneNumbers()` A list of `PhoneNumber` objects containing phone numbers associated with the user.
`String`	`getPreferredLanguage()` A string containing the preferred language of the user.
`String`	`getProfileUrl()` A string containing a URL that may be associated with the user.
`String`	`getTimezone()` A string containing the user's time zone.
`String`	`getTitle()` A string containing the user's title.
`String`	`getUserId()` The identifier for a user in the identity store.
`String`	`getUserName()` A unique string used to identify the user.
`String`	`getUserType()` A string indicating the user's type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAddresses(Collection<Address> addresses)` A list of `Address` objects containing addresses associated with the user.
`void`	`setDisplayName(String displayName)` A string containing the user's name that's formatted for display when the user is referenced.
`void`	`setEmails(Collection<Email> emails)` A list of `Email` objects containing email addresses associated with the user.
`void`	`setExternalIds(Collection<ExternalId> externalIds)` A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.
`void`	`setIdentityStoreId(String identityStoreId)` The globally unique identifier for the identity store.
`void`	`setLocale(String locale)` A string containing the user's geographical region or location.
`void`	`setName(Name name)` An object containing the user's name.
`void`	`setNickName(String nickName)` A string containing an alternate name for the user.
`void`	`setPhoneNumbers(Collection<PhoneNumber> phoneNumbers)` A list of `PhoneNumber` objects containing phone numbers associated with the user.
`void`	`setPreferredLanguage(String preferredLanguage)` A string containing the preferred language of the user.
`void`	`setProfileUrl(String profileUrl)` A string containing a URL that may be associated with the user.
`void`	`setTimezone(String timezone)` A string containing the user's time zone.
`void`	`setTitle(String title)` A string containing the user's title.
`void`	`setUserId(String userId)` The identifier for a user in the identity store.
`void`	`setUserName(String userName)` A unique string used to identify the user.
`void`	`setUserType(String userType)` A string indicating the user's type.
`String`	`toString()` Returns a string representation of this object.
`User`	`withAddresses(Address... addresses)` A list of `Address` objects containing addresses associated with the user.
`User`	`withAddresses(Collection<Address> addresses)` A list of `Address` objects containing addresses associated with the user.
`User`	`withDisplayName(String displayName)` A string containing the user's name that's formatted for display when the user is referenced.
`User`	`withEmails(Collection<Email> emails)` A list of `Email` objects containing email addresses associated with the user.
`User`	`withEmails(Email... emails)` A list of `Email` objects containing email addresses associated with the user.
`User`	`withExternalIds(Collection<ExternalId> externalIds)` A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.
`User`	`withExternalIds(ExternalId... externalIds)` A list of `ExternalId` objects that contains the identifiers issued to this resource by an external identity provider.
`User`	`withIdentityStoreId(String identityStoreId)` The globally unique identifier for the identity store.
`User`	`withLocale(String locale)` A string containing the user's geographical region or location.
`User`	`withName(Name name)` An object containing the user's name.
`User`	`withNickName(String nickName)` A string containing an alternate name for the user.
`User`	`withPhoneNumbers(Collection<PhoneNumber> phoneNumbers)` A list of `PhoneNumber` objects containing phone numbers associated with the user.
`User`	`withPhoneNumbers(PhoneNumber... phoneNumbers)` A list of `PhoneNumber` objects containing phone numbers associated with the user.
`User`	`withPreferredLanguage(String preferredLanguage)` A string containing the preferred language of the user.
`User`	`withProfileUrl(String profileUrl)` A string containing a URL that may be associated with the user.
`User`	`withTimezone(String timezone)` A string containing the user's time zone.
`User`	`withTitle(String title)` A string containing the user's title.
`User`	`withUserId(String userId)` The identifier for a user in the identity store.
`User`	`withUserName(String userName)` A unique string used to identify the user.
`User`	`withUserType(String userType)` A string indicating the user's type.

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

- Constructor Detail
  - User
```
public User()
```
- Method Detail
  - setUserName
```
public void setUserName(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.
    
    Parameters:
    
    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.
  - getUserName
```
public String getUserName()
```
    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.
  - withUserName
```
public User withUserName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserId
```
public void setUserId(String userId)
```
    The identifier for a user in the identity store.
    
    Parameters:
    
    userId - The identifier for a user in the identity store.
  - getUserId
```
public String getUserId()
```
    The identifier for a user in the identity store.
    
    Returns:
    
    The identifier for a user in the identity store.
  - withUserId
```
public User withUserId(String userId)
```
    The identifier for a user in the identity store.
    
    Parameters:
    
    userId - The identifier for a user in the identity store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExternalIds
```
public List<ExternalId> getExternalIds()
```
    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
    
    Returns:
    
    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
  - setExternalIds
```
public void setExternalIds(Collection<ExternalId> externalIds)
```
    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
    
    Parameters:
    
    externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
  - withExternalIds
```
public User withExternalIds(ExternalId... externalIds)
```
    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
    
    NOTE: This method appends the values to the existing list (if any). Use setExternalIds(java.util.Collection) or withExternalIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExternalIds
```
public User withExternalIds(Collection<ExternalId> externalIds)
```
    A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
    
    Parameters:
    
    externalIds - A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(Name name)
```
    An object containing the user's name.
    
    Parameters:
    
    name - An object containing the user's name.
  - getName
```
public Name getName()
```
    An object containing the user's name.
    
    Returns:
    
    An object containing the user's name.
  - withName
```
public User withName(Name name)
```
    An object containing the user's name.
    
    Parameters:
    
    name - An object containing the user's name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
    
    Parameters:
    
    displayName - A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
  - getDisplayName
```
public String getDisplayName()
```
    A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
    
    Returns:
    
    A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
  - withDisplayName
```
public User withDisplayName(String displayName)
```
    A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
    
    Parameters:
    
    displayName - A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNickName
```
public void setNickName(String nickName)
```
    A string containing an alternate name for the user.
    
    Parameters:
    
    nickName - A string containing an alternate name for the user.
  - getNickName
```
public String getNickName()
```
    A string containing an alternate name for the user.
    
    Returns:
    
    A string containing an alternate name for the user.
  - withNickName
```
public User withNickName(String nickName)
```
    A string containing an alternate name for the user.
    
    Parameters:
    
    nickName - A string containing an alternate name for the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProfileUrl
```
public void setProfileUrl(String profileUrl)
```
    A string containing a URL that may be associated with the user.
    
    Parameters:
    
    profileUrl - A string containing a URL that may be associated with the user.
  - getProfileUrl
```
public String getProfileUrl()
```
    A string containing a URL that may be associated with the user.
    
    Returns:
    
    A string containing a URL that may be associated with the user.
  - withProfileUrl
```
public User withProfileUrl(String profileUrl)
```
    A string containing a URL that may be associated with the user.
    
    Parameters:
    
    profileUrl - A string containing a URL that may be associated with the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEmails
```
public List<Email> getEmails()
```
    A list of Email objects containing email addresses associated with the user.
    
    Returns:
    
    A list of Email objects containing email addresses associated with the user.
  - setEmails
```
public void setEmails(Collection<Email> emails)
```
    A list of Email objects containing email addresses associated with the user.
    
    Parameters:
    
    emails - A list of Email objects containing email addresses associated with the user.
  - withEmails
```
public User withEmails(Email... emails)
```
    A list of Email objects containing email addresses associated with the user.
    
    NOTE: This method appends the values to the existing list (if any). Use setEmails(java.util.Collection) or withEmails(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    emails - A list of Email objects containing email addresses associated with the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEmails
```
public User withEmails(Collection<Email> emails)
```
    A list of Email objects containing email addresses associated with the user.
    
    Parameters:
    
    emails - A list of Email objects containing email addresses associated with the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAddresses
```
public List<Address> getAddresses()
```
    A list of Address objects containing addresses associated with the user.
    
    Returns:
    
    A list of Address objects containing addresses associated with the user.
  - setAddresses
```
public void setAddresses(Collection<Address> addresses)
```
    A list of Address objects containing addresses associated with the user.
    
    Parameters:
    
    addresses - A list of Address objects containing addresses associated with the user.
  - withAddresses
```
public User withAddresses(Address... addresses)
```
    A list of Address objects containing addresses associated with the user.
    
    NOTE: This method appends the values to the existing list (if any). Use setAddresses(java.util.Collection) or withAddresses(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    addresses - A list of Address objects containing addresses associated with the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAddresses
```
public User withAddresses(Collection<Address> addresses)
```
    A list of Address objects containing addresses associated with the user.
    
    Parameters:
    
    addresses - A list of Address objects containing addresses associated with the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPhoneNumbers
```
public List<PhoneNumber> getPhoneNumbers()
```
    A list of PhoneNumber objects containing phone numbers associated with the user.
    
    Returns:
    
    A list of PhoneNumber objects containing phone numbers associated with the user.
  - setPhoneNumbers
```
public void setPhoneNumbers(Collection<PhoneNumber> phoneNumbers)
```
    A list of PhoneNumber objects containing phone numbers associated with the user.
    
    Parameters:
    
    phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.
  - withPhoneNumbers
```
public User withPhoneNumbers(PhoneNumber... phoneNumbers)
```
    A list of PhoneNumber objects containing phone numbers associated with the user.
    
    NOTE: This method appends the values to the existing list (if any). Use setPhoneNumbers(java.util.Collection) or withPhoneNumbers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPhoneNumbers
```
public User withPhoneNumbers(Collection<PhoneNumber> phoneNumbers)
```
    A list of PhoneNumber objects containing phone numbers associated with the user.
    
    Parameters:
    
    phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserType
```
public void setUserType(String userType)
```
    A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
    
    Parameters:
    
    userType - A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
  - getUserType
```
public String getUserType()
```
    A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
    
    Returns:
    
    A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
  - withUserType
```
public User withUserType(String userType)
```
    A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
    
    Parameters:
    
    userType - A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(String title)
```
    A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
    
    Parameters:
    
    title - A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
  - getTitle
```
public String getTitle()
```
    A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
    
    Returns:
    
    A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
  - withTitle
```
public User withTitle(String title)
```
    A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
    
    Parameters:
    
    title - A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferredLanguage
```
public void setPreferredLanguage(String preferredLanguage)
```
    A string containing the preferred language of the user. For example, "American English" or "en-us."
    
    Parameters:
    
    preferredLanguage - A string containing the preferred language of the user. For example, "American English" or "en-us."
  - getPreferredLanguage
```
public String getPreferredLanguage()
```
    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."
  - withPreferredLanguage
```
public User withPreferredLanguage(String preferredLanguage)
```
    A string containing the preferred language of the user. For example, "American English" or "en-us."
    
    Parameters:
    
    preferredLanguage - A string containing the preferred language of the user. For example, "American English" or "en-us."
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocale
```
public void setLocale(String locale)
```
    A string containing the user's geographical region or location.
    
    Parameters:
    
    locale - A string containing the user's geographical region or location.
  - getLocale
```
public String getLocale()
```
    A string containing the user's geographical region or location.
    
    Returns:
    
    A string containing the user's geographical region or location.
  - withLocale
```
public User withLocale(String locale)
```
    A string containing the user's geographical region or location.
    
    Parameters:
    
    locale - A string containing the user's geographical region or location.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimezone
```
public void setTimezone(String timezone)
```
    A string containing the user's time zone.
    
    Parameters:
    
    timezone - A string containing the user's time zone.
  - getTimezone
```
public String getTimezone()
```
    A string containing the user's time zone.
    
    Returns:
    
    A string containing the user's time zone.
  - withTimezone
```
public User withTimezone(String timezone)
```
    A string containing the user's time zone.
    
    Parameters:
    
    timezone - A string containing the user's time zone.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityStoreId
```
public void setIdentityStoreId(String identityStoreId)
```
    The globally unique identifier for the identity store.
    
    Parameters:
    
    identityStoreId - The globally unique identifier for the identity store.
  - getIdentityStoreId
```
public String getIdentityStoreId()
```
    The globally unique identifier for the identity store.
    
    Returns:
    
    The globally unique identifier for the identity store.
  - withIdentityStoreId
```
public User withIdentityStoreId(String identityStoreId)
```
    The globally unique identifier for the identity store.
    
    Parameters:
    
    identityStoreId - The globally unique identifier for the identity store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public User clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class User

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

User

Method Detail

setUserName

getUserName

withUserName

setUserId

getUserId

withUserId

getExternalIds

setExternalIds

withExternalIds

withExternalIds

setName

getName

withName

setDisplayName

getDisplayName

withDisplayName

setNickName

getNickName

withNickName

setProfileUrl

getProfileUrl

withProfileUrl

getEmails

setEmails

withEmails

withEmails

getAddresses

setAddresses

withAddresses

withAddresses

getPhoneNumbers

setPhoneNumbers

withPhoneNumbers

withPhoneNumbers

setUserType

getUserType

withUserType

setTitle

getTitle

withTitle

setPreferredLanguage

getPreferredLanguage

withPreferredLanguage

setLocale

getLocale

withLocale

setTimezone

getTimezone

withTimezone

setIdentityStoreId

getIdentityStoreId

withIdentityStoreId

toString

equals

hashCode

clone

marshall