Class User
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<User.Builder,
User>
A user object that contains the metadata and attributes for a specified user.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list ofAddress
objects containing addresses associated with the user.static User.Builder
builder()
final String
A string containing the name of the user that is formatted for display when the user is referenced.emails()
A list ofEmail
objects containing email addresses associated with the user.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ExternalId> A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Addresses property.final boolean
For responses, this returns true if the service returned a value for the Emails property.final boolean
For responses, this returns true if the service returned a value for the ExternalIds property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PhoneNumbers property.final String
The globally unique identifier for the identity store.final String
locale()
A string containing the geographical region or location of the user.final Name
name()
An object containing the name of the user.final String
nickName()
A string containing an alternate name for the user.final List
<PhoneNumber> A list ofPhoneNumber
objects containing phone numbers associated with the user.final String
A string containing the preferred language of the user.final String
A string containing a URL that might be associated with the user.static Class
<? extends User.Builder> final String
timezone()
A string containing the time zone of the user.final String
title()
A string containing the title of the user.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userId()
The identifier for a user in the identity store.final String
userName()
A unique string used to identify the user.final String
userType()
A string indicating the type of user.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 theisEmpty()
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
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
An object containing the name of the user.
- Returns:
- An object containing the name of the user.
-
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
A string containing an alternate name for the user.
- Returns:
- A string containing an alternate name for the user.
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
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
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
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
A string containing the geographical region or location of the user.
- Returns:
- A string containing the geographical region or location of the user.
-
timezone
A string containing the time zone of the user.
- Returns:
- A string containing the time zone of the user.
-
identityStoreId
The globally unique identifier for the identity store.
- Returns:
- The globally unique identifier for the identity store.
-
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 interfaceToCopyableBuilder<User.Builder,
User> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-