Interface DescribeUserResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>, IdentitystoreResponse.Builder, SdkBuilder<DescribeUserResponse.Builder,DescribeUserResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeUserResponse
@Mutable @NotThreadSafe public static interface DescribeUserResponse.Builder extends IdentitystoreResponse.Builder, SdkPojo, CopyableBuilder<DescribeUserResponse.Builder,DescribeUserResponse>

  • Method Details

    • 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.

    • 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.

    • 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.

    • 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<ExternalId>).

      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:

    • 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:

    • 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<Email>).

      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:

    • 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<Address>).

      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:

    • 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<PhoneNumber>).

      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:

    • 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.

    • userStatus

      DescribeUserResponse.Builder userStatus(String userStatus)

      The current status of the user account.

      Parameters:
      userStatus - The current status of the user account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userStatus

      DescribeUserResponse.Builder userStatus(UserStatus userStatus)

      The current status of the user account.

      Parameters:
      userStatus - The current status of the user account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • photos

      DescribeUserResponse.Builder photos(Collection<Photo> photos)

      A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.

      Parameters:
      photos - A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • photos

      DescribeUserResponse.Builder photos(Photo... photos)

      A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.

      Parameters:
      photos - A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • photos

      DescribeUserResponse.Builder photos(Consumer<Photo.Builder>... photos)

      A list of photos associated with the user. Returns up to 3 photos with their associated metadata including type, display name, and primary designation.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to photos(List<Photo>).

      Parameters:
      photos - a consumer that will call methods on Photo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • website

      DescribeUserResponse.Builder website(String website)

      The user's personal website or blog URL. Returns the stored website information for the user.

      Parameters:
      website - The user's personal website or blog URL. Returns the stored website information for the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • birthdate

      DescribeUserResponse.Builder birthdate(String birthdate)

      The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.

      Parameters:
      birthdate - The user's birthdate in YYYY-MM-DD format. This field returns the stored birthdate information for the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      DescribeUserResponse.Builder createdAt(Instant createdAt)

      The date and time the user was created.

      Parameters:
      createdAt - The date and time the user was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      DescribeUserResponse.Builder createdBy(String createdBy)

      The identifier of the user or system that created the user.

      Parameters:
      createdBy - The identifier of the user or system that created the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      DescribeUserResponse.Builder updatedAt(Instant updatedAt)

      The date and time the user was last updated.

      Parameters:
      updatedAt - The date and time the user was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedBy

      DescribeUserResponse.Builder updatedBy(String updatedBy)

      The identifier of the user or system that last updated the user.

      Parameters:
      updatedBy - The identifier of the user or system that last updated the user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.