Package software.amazon.awssdk.services.customerprofiles.model

Interface Profile.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Profile.Builder,Profile>, SdkBuilder<Profile.Builder,Profile>, SdkPojo
Enclosing class:
Profile
public static interface Profile.Builder extends SdkPojo, CopyableBuilder<Profile.Builder,Profile>

  • Method Details

    • profileId

      Profile.Builder profileId(String profileId)

      The unique identifier of a customer profile.

      Parameters:
      profileId - The unique identifier of a customer profile.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountNumber

      Profile.Builder accountNumber(String accountNumber)

      A unique account number that you have given to the customer.

      Parameters:
      accountNumber - A unique account number that you have given to the customer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalInformation

      Profile.Builder additionalInformation(String additionalInformation)

      Any additional information relevant to the customer’s profile.

      Parameters:
      additionalInformation - Any additional information relevant to the customer’s profile.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partyType

      Profile.Builder partyType(String partyType)

      The type of profile used to describe the customer.

      Parameters:
      partyType - The type of profile used to describe the customer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • partyType

      Profile.Builder partyType(PartyType partyType)

      The type of profile used to describe the customer.

      Parameters:
      partyType - The type of profile used to describe the customer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • businessName

      Profile.Builder businessName(String businessName)

      The name of the customer’s business.

      Parameters:
      businessName - The name of the customer’s business.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firstName

      Profile.Builder firstName(String firstName)

      The customer’s first name.

      Parameters:
      firstName - The customer’s first name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • middleName

      Profile.Builder middleName(String middleName)

      The customer’s middle name.

      Parameters:
      middleName - The customer’s middle name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastName

      Profile.Builder lastName(String lastName)

      The customer’s last name.

      Parameters:
      lastName - The customer’s last name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • birthDate

      Profile.Builder birthDate(String birthDate)

      The customer’s birth date.

      Parameters:
      birthDate - The customer’s birth date.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gender

      Profile.Builder gender(String gender)

      The gender with which the customer identifies.

      Parameters:
      gender - The gender with which the customer identifies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • gender

      Profile.Builder gender(Gender gender)

      The gender with which the customer identifies.

      Parameters:
      gender - The gender with which the customer identifies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • phoneNumber

      Profile.Builder phoneNumber(String phoneNumber)

      The customer's phone number, which has not been specified as a mobile, home, or business number.

      Parameters:
      phoneNumber - The customer's phone number, which has not been specified as a mobile, home, or business number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mobilePhoneNumber

      Profile.Builder mobilePhoneNumber(String mobilePhoneNumber)

      The customer’s mobile phone number.

      Parameters:
      mobilePhoneNumber - The customer’s mobile phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • homePhoneNumber

      Profile.Builder homePhoneNumber(String homePhoneNumber)

      The customer’s home phone number.

      Parameters:
      homePhoneNumber - The customer’s home phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • businessPhoneNumber

      Profile.Builder businessPhoneNumber(String businessPhoneNumber)

      The customer’s home phone number.

      Parameters:
      businessPhoneNumber - The customer’s home phone number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emailAddress

      Profile.Builder emailAddress(String emailAddress)

      The customer’s email address, which has not been specified as a personal or business address.

      Parameters:
      emailAddress - The customer’s email address, which has not been specified as a personal or business address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • personalEmailAddress

      Profile.Builder personalEmailAddress(String personalEmailAddress)

      The customer’s personal email address.

      Parameters:
      personalEmailAddress - The customer’s personal email address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • businessEmailAddress

      Profile.Builder businessEmailAddress(String businessEmailAddress)

      The customer’s business email address.

      Parameters:
      businessEmailAddress - The customer’s business email address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • address

      Profile.Builder address(Address address)

      A generic address associated with the customer that is not mailing, shipping, or billing.

      Parameters:
      address - A generic address associated with the customer that is not mailing, shipping, or billing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • address

      default Profile.Builder address(Consumer<Address.Builder> address)

      A generic address associated with the customer that is not mailing, shipping, or billing.

      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 address(Address).

      Parameters:
      address - 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:

    • shippingAddress

      Profile.Builder shippingAddress(Address shippingAddress)

      The customer’s shipping address.

      Parameters:
      shippingAddress - The customer’s shipping address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shippingAddress

      default Profile.Builder shippingAddress(Consumer<Address.Builder> shippingAddress)

      The customer’s shipping address.

      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 shippingAddress(Address).

      Parameters:
      shippingAddress - 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:

    • mailingAddress

      Profile.Builder mailingAddress(Address mailingAddress)

      The customer’s mailing address.

      Parameters:
      mailingAddress - The customer’s mailing address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mailingAddress

      default Profile.Builder mailingAddress(Consumer<Address.Builder> mailingAddress)

      The customer’s mailing address.

      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 mailingAddress(Address).

      Parameters:
      mailingAddress - 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:

    • billingAddress

      Profile.Builder billingAddress(Address billingAddress)

      The customer’s billing address.

      Parameters:
      billingAddress - The customer’s billing address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • billingAddress

      default Profile.Builder billingAddress(Consumer<Address.Builder> billingAddress)

      The customer’s billing address.

      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 billingAddress(Address).

      Parameters:
      billingAddress - 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:

    • attributes

      Profile.Builder attributes(Map<String,String> attributes)

      A key value pair of attributes of a customer profile.

      Parameters:
      attributes - A key value pair of attributes of a customer profile.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • foundByItems

      Profile.Builder foundByItems(Collection<FoundByKeyValue> foundByItems)

      A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

      If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

      • AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).

      • OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

      The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

      Parameters:
      foundByItems - A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

      If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

      • AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).

      • OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

      The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

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

    • foundByItems

      Profile.Builder foundByItems(FoundByKeyValue... foundByItems)

      A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

      If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

      • AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).

      • OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

      The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

      Parameters:
      foundByItems - A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

      If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

      • AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).

      • OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

      The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

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

    • foundByItems

      Profile.Builder foundByItems(Consumer<FoundByKeyValue.Builder>... foundByItems)

      A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

      If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

      • AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).

      • OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

      The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

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

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

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

    • partyTypeString

      Profile.Builder partyTypeString(String partyTypeString)

      An alternative to PartyType which accepts any string as input.

      Parameters:
      partyTypeString - An alternative to PartyType which accepts any string as input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • genderString

      Profile.Builder genderString(String genderString)

      An alternative to Gender which accepts any string as input.

      Parameters:
      genderString - An alternative to Gender which accepts any string as input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.