Interface User.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<User.Builder,
,User> SdkBuilder<User.Builder,
,User> SdkPojo
- Enclosing class:
User
-
Method Summary
Modifier and TypeMethodDescriptionaddresses
(Collection<Address> addresses) A list ofAddress
objects containing addresses associated with the user.addresses
(Consumer<Address.Builder>... addresses) A list ofAddress
objects containing addresses associated with the user.A list ofAddress
objects containing addresses associated with the user.displayName
(String displayName) A string containing the name of the user that is formatted for display when the user is referenced.emails
(Collection<Email> emails) A list ofEmail
objects containing email addresses associated with the user.emails
(Consumer<Email.Builder>... emails) A list ofEmail
objects containing email addresses associated with the user.A list ofEmail
objects containing email addresses associated with the user.externalIds
(Collection<ExternalId> externalIds) A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.externalIds
(Consumer<ExternalId.Builder>... externalIds) A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.externalIds
(ExternalId... externalIds) A list ofExternalId
objects that contains the identifiers issued to this resource by an external identity provider.identityStoreId
(String identityStoreId) The globally unique identifier for the identity store.A string containing the geographical region or location of the user.default User.Builder
name
(Consumer<Name.Builder> name) An object containing the name of the user.An object containing the name of the user.A string containing an alternate name for the user.phoneNumbers
(Collection<PhoneNumber> phoneNumbers) A list ofPhoneNumber
objects containing phone numbers associated with the user.phoneNumbers
(Consumer<PhoneNumber.Builder>... phoneNumbers) A list ofPhoneNumber
objects containing phone numbers associated with the user.phoneNumbers
(PhoneNumber... phoneNumbers) A list ofPhoneNumber
objects containing phone numbers associated with the user.preferredLanguage
(String preferredLanguage) A string containing the preferred language of the user.profileUrl
(String profileUrl) A string containing a URL that might be associated with the user.A string containing the time zone of the user.A string containing the title of the user.The identifier for a user in the identity store.A unique string used to identify the user.A string indicating the type of user.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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.
- 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.
-
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.
-
externalIds
A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.- Parameters:
externalIds
- A list ofExternalId
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.
-
externalIds
A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.- Parameters:
externalIds
- A list ofExternalId
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.
-
externalIds
A list of
This is a convenience method that creates an instance of theExternalId
objects that contains the identifiers issued to this resource by an external identity provider.ExternalId.Builder
avoiding the need to create one manually viaExternalId.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexternalIds(List<ExternalId>)
.- Parameters:
externalIds
- a consumer that will call methods onExternalId.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
An object containing the name of the user.
- Parameters:
name
- An object containing the name of the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
An object containing the name of the user.
This is a convenience method that creates an instance of theName.Builder
avoiding the need to create one manually viaName.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toname(Name)
.- Parameters:
name
- a consumer that will call methods onName.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
displayName
A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."
- Parameters:
displayName
- A string containing the name of the user that is 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.
-
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.
-
profileUrl
A string containing a URL that might be associated with the user.
- Parameters:
profileUrl
- A string containing a URL that might be associated with the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emails
A list of
Email
objects containing email addresses associated with the user.- Parameters:
emails
- A list ofEmail
objects containing email addresses associated with the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emails
A list of
Email
objects containing email addresses associated with the user.- Parameters:
emails
- A list ofEmail
objects containing email addresses associated with the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emails
A list of
This is a convenience method that creates an instance of theEmail
objects containing email addresses associated with the user.Email.Builder
avoiding the need to create one manually viaEmail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toemails(List<Email>)
.- Parameters:
emails
- a consumer that will call methods onEmail.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
addresses
A list of
Address
objects containing addresses associated with the user.- Parameters:
addresses
- A list ofAddress
objects containing addresses associated with the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addresses
A list of
Address
objects containing addresses associated with the user.- Parameters:
addresses
- A list ofAddress
objects containing addresses associated with the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addresses
A list of
This is a convenience method that creates an instance of theAddress
objects containing addresses associated with the user.Address.Builder
avoiding the need to create one manually viaAddress.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaddresses(List<Address>)
.- Parameters:
addresses
- a consumer that will call methods onAddress.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
phoneNumbers
A list of
PhoneNumber
objects containing phone numbers associated with the user.- Parameters:
phoneNumbers
- A list ofPhoneNumber
objects containing phone numbers associated with the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
phoneNumbers
A list of
PhoneNumber
objects containing phone numbers associated with the user.- Parameters:
phoneNumbers
- A list ofPhoneNumber
objects containing phone numbers associated with the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
phoneNumbers
A list of
This is a convenience method that creates an instance of thePhoneNumber
objects containing phone numbers associated with the user.PhoneNumber.Builder
avoiding the need to create one manually viaPhoneNumber.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tophoneNumbers(List<PhoneNumber>)
.- Parameters:
phoneNumbers
- a consumer that will call methods onPhoneNumber.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
userType
A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
- Parameters:
userType
- A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
title
A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
locale
A string containing the geographical region or location of the user.
- Parameters:
locale
- A string containing the geographical region or location of the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timezone
A string containing the time zone of the user.
- Parameters:
timezone
- A string containing the time zone of the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-