Class ProfileAttributes

java.lang.Object
software.amazon.awssdk.services.customerprofiles.model.ProfileAttributes
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProfileAttributes.Builder,ProfileAttributes>
@Generated("software.amazon.awssdk:codegen") public final class ProfileAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProfileAttributes.Builder,ProfileAttributes>

The object used to segment on attributes within the customer profile.

See Also:

  • Method Details

    • accountNumber

      public final ProfileDimension accountNumber()

      A field to describe values to segment on within account number.

      Returns:
      A field to describe values to segment on within account number.

    • additionalInformation

      public final ExtraLengthValueProfileDimension additionalInformation()

      A field to describe values to segment on within additional information.

      Returns:
      A field to describe values to segment on within additional information.

    • firstName

      public final ProfileDimension firstName()

      A field to describe values to segment on within first name.

      Returns:
      A field to describe values to segment on within first name.

    • lastName

      public final ProfileDimension lastName()

      A field to describe values to segment on within last name.

      Returns:
      A field to describe values to segment on within last name.

    • middleName

      public final ProfileDimension middleName()

      A field to describe values to segment on within middle name.

      Returns:
      A field to describe values to segment on within middle name.

    • genderString

      public final ProfileDimension genderString()

      A field to describe values to segment on within genderString.

      Returns:
      A field to describe values to segment on within genderString.

    • partyTypeString

      public final ProfileDimension partyTypeString()

      A field to describe values to segment on within partyTypeString.

      Returns:
      A field to describe values to segment on within partyTypeString.

    • birthDate

      public final DateDimension birthDate()

      A field to describe values to segment on within birthDate.

      Returns:
      A field to describe values to segment on within birthDate.

    • phoneNumber

      public final ProfileDimension phoneNumber()

      A field to describe values to segment on within phone number.

      Returns:
      A field to describe values to segment on within phone number.

    • businessName

      public final ProfileDimension businessName()

      A field to describe values to segment on within business name.

      Returns:
      A field to describe values to segment on within business name.

    • businessPhoneNumber

      public final ProfileDimension businessPhoneNumber()

      A field to describe values to segment on within business phone number.

      Returns:
      A field to describe values to segment on within business phone number.

    • homePhoneNumber

      public final ProfileDimension homePhoneNumber()

      A field to describe values to segment on within home phone number.

      Returns:
      A field to describe values to segment on within home phone number.

    • mobilePhoneNumber

      public final ProfileDimension mobilePhoneNumber()

      A field to describe values to segment on within mobile phone number.

      Returns:
      A field to describe values to segment on within mobile phone number.

    • emailAddress

      public final ProfileDimension emailAddress()

      A field to describe values to segment on within email address.

      Returns:
      A field to describe values to segment on within email address.

    • personalEmailAddress

      public final ProfileDimension personalEmailAddress()

      A field to describe values to segment on within personal email address.

      Returns:
      A field to describe values to segment on within personal email address.

    • businessEmailAddress

      public final ProfileDimension businessEmailAddress()

      A field to describe values to segment on within business email address.

      Returns:
      A field to describe values to segment on within business email address.

    • address

      public final AddressDimension address()

      A field to describe values to segment on within address.

      Returns:
      A field to describe values to segment on within address.

    • shippingAddress

      public final AddressDimension shippingAddress()

      A field to describe values to segment on within shipping address.

      Returns:
      A field to describe values to segment on within shipping address.

    • mailingAddress

      public final AddressDimension mailingAddress()

      A field to describe values to segment on within mailing address.

      Returns:
      A field to describe values to segment on within mailing address.

    • billingAddress

      public final AddressDimension billingAddress()

      A field to describe values to segment on within billing address.

      Returns:
      A field to describe values to segment on within 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,AttributeDimension> attributes()

      A field to describe values to segment on within attributes.

      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 field to describe values to segment on within attributes.

    • toBuilder

      public ProfileAttributes.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ProfileAttributes.Builder,ProfileAttributes>
      Returns:
      a builder for type T

    • builder

      public static ProfileAttributes.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ProfileAttributes.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.