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

Class AttributeTypesSelector

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

Configuration information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles. You can choose how profiles are compared across attribute types and which attribute to use for matching from each type. There are three attribute types you can configure:

  • Email type

    • You can choose from Email, BusinessEmail, and PersonalEmail

  • Phone number type

    • You can choose from Phone, HomePhone, and MobilePhone

  • Address type

    • You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress

You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel . When choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of the Email field of Profile B matches, the two profiles are matched on the Email type.

See Also:

  • Method Details

    • attributeMatchingModel

      public final AttributeMatchingModel attributeMatchingModel()

      Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

      If the service returns an enum value that is not available in the current SDK version, attributeMatchingModel will return AttributeMatchingModel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeMatchingModelAsString().

      Returns:
      Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.
      See Also:

    • attributeMatchingModelAsString

      public final String attributeMatchingModelAsString()

      Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

      If the service returns an enum value that is not available in the current SDK version, attributeMatchingModel will return AttributeMatchingModel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeMatchingModelAsString().

      Returns:
      Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.
      See Also:

    • hasAddress

      public final boolean hasAddress()
      For responses, this returns true if the service returned a value for the Address 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.

    • address

      public final List<String> address()

      The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.

      You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

      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 hasAddress() method.

      Returns:
      The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.

      You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

    • hasPhoneNumber

      public final boolean hasPhoneNumber()
      For responses, this returns true if the service returned a value for the PhoneNumber 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.

    • phoneNumber

      public final List<String> phoneNumber()

      The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.

      You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

      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 hasPhoneNumber() method.

      Returns:
      The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.

      You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

    • hasEmailAddress

      public final boolean hasEmailAddress()
      For responses, this returns true if the service returned a value for the EmailAddress 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.

    • emailAddress

      public final List<String> emailAddress()

      The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.

      You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

      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 hasEmailAddress() method.

      Returns:
      The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.

      You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

    • toBuilder

      public AttributeTypesSelector.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<AttributeTypesSelector.Builder,AttributeTypesSelector>
      Returns:
      a builder for type T

    • builder

      public static AttributeTypesSelector.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AttributeTypesSelector.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.