software.amazon.awssdk.services.identitystore.model

Interface DescribeUserResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>, IdentitystoreResponse.Builder, SdkBuilder<DescribeUserResponse.Builder,DescribeUserResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeUserResponse

public static interface DescribeUserResponse.Builder
extends IdentitystoreResponse.Builder, SdkPojo, CopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>

Method Summary

Modifier and Type	Method and Description
DescribeUserResponse.Builder	addresses(Address... addresses) The physical address of the user.
DescribeUserResponse.Builder	addresses(Collection<Address> addresses) The physical address of the user.
DescribeUserResponse.Builder	addresses(Consumer<Address.Builder>... addresses) The physical address of the user.
DescribeUserResponse.Builder	displayName(String displayName) The display name of the user.
DescribeUserResponse.Builder	emails(Collection<Email> emails) The email address of the user.
DescribeUserResponse.Builder	emails(Consumer<Email.Builder>... emails) The email address of the user.
DescribeUserResponse.Builder	emails(Email... emails) The email address of the user.
DescribeUserResponse.Builder	externalIds(Collection<ExternalId> externalIds) A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
DescribeUserResponse.Builder	externalIds(Consumer<ExternalId.Builder>... externalIds) A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
DescribeUserResponse.Builder	externalIds(ExternalId... externalIds) A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.
DescribeUserResponse.Builder	identityStoreId(String identityStoreId) The globally unique identifier for the identity store.
DescribeUserResponse.Builder	locale(String locale) A string containing the geographical region or location of the user.
default DescribeUserResponse.Builder	name(Consumer<Name.Builder> name) The name of the user.
DescribeUserResponse.Builder	name(Name name) The name of the user.
DescribeUserResponse.Builder	nickName(String nickName) An alternative descriptive name for the user.
DescribeUserResponse.Builder	phoneNumbers(Collection<PhoneNumber> phoneNumbers) A list of PhoneNumber objects associated with a user.
DescribeUserResponse.Builder	phoneNumbers(Consumer<PhoneNumber.Builder>... phoneNumbers) A list of PhoneNumber objects associated with a user.
DescribeUserResponse.Builder	phoneNumbers(PhoneNumber... phoneNumbers) A list of PhoneNumber objects associated with a user.
DescribeUserResponse.Builder	preferredLanguage(String preferredLanguage) The preferred language of the user.
DescribeUserResponse.Builder	profileUrl(String profileUrl) A URL link for the user's profile.
DescribeUserResponse.Builder	timezone(String timezone) The time zone for a user.
DescribeUserResponse.Builder	title(String title) A string containing the title of the user.
DescribeUserResponse.Builder	userId(String userId) The identifier for a user in the identity store.
DescribeUserResponse.Builder	userName(String userName) A unique string used to identify the user.
DescribeUserResponse.Builder	userType(String userType) A string indicating the type of user.

Methods inherited from interface software.amazon.awssdk.services.identitystore.model.IdentitystoreResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

userName

DescribeUserResponse.Builder userName(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.

userId

DescribeUserResponse.Builder userId(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.

externalIds

DescribeUserResponse.Builder externalIds(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.

externalIds

DescribeUserResponse.Builder externalIds(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.

externalIds

DescribeUserResponse.Builder externalIds(Consumer<ExternalId.Builder>... externalIds)

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

This is a convenience method that creates an instance of the ExternalId.Builder avoiding the need to create one manually via ExternalId.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #externalIds(List).

Parameters:

externalIds - a consumer that will call methods on ExternalId.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#externalIds(java.util.Collection)

name

DescribeUserResponse.Builder name(Name name)

The name of the user.

Parameters:

name - The name of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

default DescribeUserResponse.Builder name(Consumer<Name.Builder> name)

The name of the user.

This is a convenience method that creates an instance of the Name.Builder avoiding the need to create one manually via Name.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to name(Name).

Parameters:

name - a consumer that will call methods on Name.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

name(Name)

displayName

DescribeUserResponse.Builder displayName(String displayName)

The display name of the user.

Parameters:

displayName - The display name of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

nickName

DescribeUserResponse.Builder nickName(String nickName)

An alternative descriptive name for the user.

Parameters:

nickName - An alternative descriptive name for the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

profileUrl

DescribeUserResponse.Builder profileUrl(String profileUrl)

A URL link for the user's profile.

Parameters:

profileUrl - A URL link for the user's profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

emails

DescribeUserResponse.Builder emails(Collection<Email> emails)

The email address of the user.

Parameters:

emails - The email address of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

emails

DescribeUserResponse.Builder emails(Email... emails)

The email address of the user.

Parameters:

emails - The email address of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

emails

DescribeUserResponse.Builder emails(Consumer<Email.Builder>... emails)

The email address of the user.

This is a convenience method that creates an instance of the Email.Builder avoiding the need to create one manually via Email.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #emails(List).

Parameters:

emails - a consumer that will call methods on Email.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#emails(java.util.Collection)

addresses

DescribeUserResponse.Builder addresses(Collection<Address> addresses)

The physical address of the user.

Parameters:

addresses - The physical address of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

addresses

DescribeUserResponse.Builder addresses(Address... addresses)

The physical address of the user.

Parameters:

addresses - The physical address of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

addresses

DescribeUserResponse.Builder addresses(Consumer<Address.Builder>... addresses)

The physical address of the user.

This is a convenience method that creates an instance of the Address.Builder avoiding the need to create one manually via Address.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #addresses(List

).

Parameters:

addresses - a consumer that will call methods on Address.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#addresses(java.util.Collection

)

phoneNumbers

DescribeUserResponse.Builder phoneNumbers(Collection<PhoneNumber> phoneNumbers)

A list of PhoneNumber objects associated with a user.

Parameters:

phoneNumbers - A list of PhoneNumber objects associated with a user.

Returns:

Returns a reference to this object so that method calls can be chained together.

phoneNumbers

DescribeUserResponse.Builder phoneNumbers(PhoneNumber... phoneNumbers)

A list of PhoneNumber objects associated with a user.

Parameters:

phoneNumbers - A list of PhoneNumber objects associated with a user.

Returns:

Returns a reference to this object so that method calls can be chained together.

phoneNumbers

DescribeUserResponse.Builder phoneNumbers(Consumer<PhoneNumber.Builder>... phoneNumbers)

A list of PhoneNumber objects associated with a user.

This is a convenience method that creates an instance of the PhoneNumber.Builder avoiding the need to create one manually via PhoneNumber.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #phoneNumbers(List).

Parameters:

phoneNumbers - a consumer that will call methods on PhoneNumber.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#phoneNumbers(java.util.Collection)

userType

DescribeUserResponse.Builder userType(String userType)

A string indicating the type of user.

Parameters:

userType - A string indicating the type of user.

Returns:

Returns a reference to this object so that method calls can be chained together.

title

DescribeUserResponse.Builder title(String title)

A string containing the title of the user.

Parameters:

title - A string containing the title of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredLanguage

DescribeUserResponse.Builder preferredLanguage(String preferredLanguage)

The preferred language of the user.

Parameters:

preferredLanguage - The preferred language of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

locale

DescribeUserResponse.Builder locale(String 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

DescribeUserResponse.Builder timezone(String timezone)

The time zone for a user.

Parameters:

timezone - The time zone for a user.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityStoreId

DescribeUserResponse.Builder identityStoreId(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.