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

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

@Generated("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 Description

static interface Profile.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accountNumber()`	An 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.
`List<FoundByKeyValue>`	`foundByItems()`	A list of items used to find a profile returned in a SearchProfiles response.
`Gender`	`gender()`	The gender with which the customer identifies.
`String`	`genderAsString()`	The gender with which the customer identifies.
`String`	`genderString()`	An alternative to Gender which accepts any string as input.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`boolean`	`hasFoundByItems()`	For responses, this returns true if the service returned a value for the FoundByItems property.
`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`	`partyTypeString()`	An alternative to PartyType which accepts any string as input.
`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 final String profileId()
```
    The unique identifier of a customer profile.
    
    Returns:
    
    The unique identifier of a customer profile.
  - accountNumber
```
public final String accountNumber()
```
    An account number that you have given to the customer.
    
    Returns:
    
    An account number that you have given to the customer.
  - additionalInformation
```
public final String additionalInformation()
```
    Any additional information relevant to the customer’s profile.
    
    Returns:
    
    Any additional information relevant to the customer’s profile.
  - partyType
```
public final 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 final 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 final String businessName()
```
    The name of the customer’s business.
    
    Returns:
    
    The name of the customer’s business.
  - firstName
```
public final String firstName()
```
    The customer’s first name.
    
    Returns:
    
    The customer’s first name.
  - middleName
```
public final String middleName()
```
    The customer’s middle name.
    
    Returns:
    
    The customer’s middle name.
  - lastName
```
public final String lastName()
```
    The customer’s last name.
    
    Returns:
    
    The customer’s last name.
  - birthDate
```
public final String birthDate()
```
    The customer’s birth date.
    
    Returns:
    
    The customer’s birth date.
  - gender
```
public final 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 final 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 final 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 final String mobilePhoneNumber()
```
    The customer’s mobile phone number.
    
    Returns:
    
    The customer’s mobile phone number.
  - homePhoneNumber
```
public final String homePhoneNumber()
```
    The customer’s home phone number.
    
    Returns:
    
    The customer’s home phone number.
  - businessPhoneNumber
```
public final String businessPhoneNumber()
```
    The customer’s home phone number.
    
    Returns:
    
    The customer’s home phone number.
  - emailAddress
```
public final 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 final String personalEmailAddress()
```
    The customer’s personal email address.
    
    Returns:
    
    The customer’s personal email address.
  - businessEmailAddress
```
public final String businessEmailAddress()
```
    The customer’s business email address.
    
    Returns:
    
    The customer’s business email address.
  - address
```
public final 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 final Address shippingAddress()
```
    The customer’s shipping address.
    
    Returns:
    
    The customer’s shipping address.
  - mailingAddress
```
public final Address mailingAddress()
```
    The customer’s mailing address.
    
    Returns:
    
    The customer’s mailing address.
  - billingAddress
```
public final Address billingAddress()
```
    The customer’s billing address.
    
    Returns:
    
    The customer’s billing address.
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attributes
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.
    
    Returns:
    
    A key value pair of attributes of a customer profile.
  - hasFoundByItems
```
public final boolean hasFoundByItems()
```
    For responses, this returns true if the service returned a value for the FoundByItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - foundByItems
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFoundByItems() method.
    Returns:
    
    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.
  - partyTypeString
```
public final String partyTypeString()
```
    An alternative to PartyType which accepts any string as input.
    
    Returns:
    
    An alternative to PartyType which accepts any string as input.
  - genderString
```
public final String genderString()
```
    An alternative to Gender which accepts any string as input.
    
    Returns:
    
    An alternative to Gender which accepts any string as input.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final 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

hasFoundByItems

foundByItems

partyTypeString

genderString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields