Profile (AWS Java SDK :: Services :: Customer Profiles 2.15.45 API)

java.lang.Object
- software.amazon.awssdk.services.customerprofiles.model.Profile

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Profile.Builder,Profile>

@Generated(value="software.amazon.awssdk:codegen")
public final class Profile
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Profile.Builder,Profile>

The standard profile of a customer.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Profile.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Profile.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accountNumber()` A unique account number that you have given to the customer.
`String`	`additionalInformation()` Any additional information relevant to the customer's profile.
`Address`	`address()` A generic address associated with the customer that is not mailing, shipping, or billing.
`Map<String,String>`	`attributes()` A key value pair of attributes of a customer profile.
`Address`	`billingAddress()` The customer’s billing address.
`String`	`birthDate()` The customer’s birth date.
`static Profile.Builder`	`builder()`
`String`	`businessEmailAddress()` The customer’s business email address.
`String`	`businessName()` The name of the customer’s business.
`String`	`businessPhoneNumber()` The customer’s home phone number.
`String`	`emailAddress()` The customer's email address, which has not been specified as a personal or business address.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`firstName()` The customer’s first name.
`Gender`	`gender()` The gender with which the customer identifies.
`String`	`genderAsString()` The gender with which the customer identifies.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()` Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`homePhoneNumber()` The customer’s home phone number.
`String`	`lastName()` The customer’s last name.
`Address`	`mailingAddress()` The customer’s mailing address.
`String`	`middleName()` The customer’s middle name.
`String`	`mobilePhoneNumber()` The customer’s mobile phone number.
`PartyType`	`partyType()` The type of profile used to describe the customer.
`String`	`partyTypeAsString()` The type of profile used to describe the customer.
`String`	`personalEmailAddress()` The customer’s personal email address.
`String`	`phoneNumber()` The customer's phone number, which has not been specified as a mobile, home, or business number.
`String`	`profileId()` The unique identifier of a customer profile.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Profile.Builder>`	`serializableBuilderClass()`
`Address`	`shippingAddress()` The customer’s shipping address.
`Profile.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - profileId
```
public String profileId()
```
    The unique identifier of a customer profile.
    
    Returns:
    
    The unique identifier of a customer profile.
  - accountNumber
```
public String accountNumber()
```
    A unique account number that you have given to the customer.
    
    Returns:
    
    A unique account number that you have given to the customer.
  - additionalInformation
```
public String additionalInformation()
```
    Any additional information relevant to the customer's profile.
    
    Returns:
    
    Any additional information relevant to the customer's profile.
  - partyType
```
public PartyType partyType()
```
    The type of profile used to describe the customer.
    
    If the service returns an enum value that is not available in the current SDK version, partyType will return PartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partyTypeAsString().
    
    Returns:
    
    The type of profile used to describe the customer.
    
    See Also:
    
    PartyType
  - partyTypeAsString
```
public String partyTypeAsString()
```
    The type of profile used to describe the customer.
    
    If the service returns an enum value that is not available in the current SDK version, partyType will return PartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partyTypeAsString().
    
    Returns:
    
    The type of profile used to describe the customer.
    
    See Also:
    
    PartyType
  - businessName
```
public String businessName()
```
    The name of the customer’s business.
    
    Returns:
    
    The name of the customer’s business.
  - firstName
```
public String firstName()
```
    The customer’s first name.
    
    Returns:
    
    The customer’s first name.
  - middleName
```
public String middleName()
```
    The customer’s middle name.
    
    Returns:
    
    The customer’s middle name.
  - lastName
```
public String lastName()
```
    The customer’s last name.
    
    Returns:
    
    The customer’s last name.
  - birthDate
```
public String birthDate()
```
    The customer’s birth date.
    
    Returns:
    
    The customer’s birth date.
  - gender
```
public Gender gender()
```
    The gender with which the customer identifies.
    
    If the service returns an enum value that is not available in the current SDK version, gender will return Gender.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from genderAsString().
    
    Returns:
    
    The gender with which the customer identifies.
    
    See Also:
    
    Gender
  - genderAsString
```
public String genderAsString()
```
    The gender with which the customer identifies.
    
    If the service returns an enum value that is not available in the current SDK version, gender will return Gender.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from genderAsString().
    
    Returns:
    
    The gender with which the customer identifies.
    
    See Also:
    
    Gender
  - phoneNumber
```
public String phoneNumber()
```
    The customer's phone number, which has not been specified as a mobile, home, or business number.
    
    Returns:
    
    The customer's phone number, which has not been specified as a mobile, home, or business number.
  - mobilePhoneNumber
```
public String mobilePhoneNumber()
```
    The customer’s mobile phone number.
    
    Returns:
    
    The customer’s mobile phone number.
  - homePhoneNumber
```
public String homePhoneNumber()
```
    The customer’s home phone number.
    
    Returns:
    
    The customer’s home phone number.
  - businessPhoneNumber
```
public String businessPhoneNumber()
```
    The customer’s home phone number.
    
    Returns:
    
    The customer’s home phone number.
  - emailAddress
```
public String emailAddress()
```
    The customer's email address, which has not been specified as a personal or business address.
    
    Returns:
    
    The customer's email address, which has not been specified as a personal or business address.
  - personalEmailAddress
```
public String personalEmailAddress()
```
    The customer’s personal email address.
    
    Returns:
    
    The customer’s personal email address.
  - businessEmailAddress
```
public String businessEmailAddress()
```
    The customer’s business email address.
    
    Returns:
    
    The customer’s business email address.
  - address
```
public Address address()
```
    A generic address associated with the customer that is not mailing, shipping, or billing.
    
    Returns:
    
    A generic address associated with the customer that is not mailing, shipping, or billing.
  - shippingAddress
```
public Address shippingAddress()
```
    The customer’s shipping address.
    
    Returns:
    
    The customer’s shipping address.
  - mailingAddress
```
public Address mailingAddress()
```
    The customer’s mailing address.
    
    Returns:
    
    The customer’s mailing address.
  - billingAddress
```
public Address billingAddress()
```
    The customer’s billing address.
    
    Returns:
    
    The customer’s billing address.
  - hasAttributes
```
public boolean hasAttributes()
```
    Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - attributes
```
public Map<String,String> attributes()
```
    A key value pair of attributes of a customer profile.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAttributes() to see if a value was sent in this field.
    
    Returns:
    
    A key value pair of attributes of a customer profile.
  - toBuilder
```
public Profile.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Profile.Builder,Profile>
  - builder
```
public static Profile.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Profile.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Profile

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

profileId

accountNumber

additionalInformation

partyType

partyTypeAsString

businessName

firstName

middleName

lastName

birthDate

gender

genderAsString

phoneNumber

mobilePhoneNumber

homePhoneNumber

businessPhoneNumber

emailAddress

personalEmailAddress

businessEmailAddress

address

shippingAddress

mailingAddress

billingAddress

hasAttributes

attributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields