Class RuleBasedMatchingResponse

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

The response of the Rule-based matching request.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      The flag that enables the rule-based matching process of duplicate profiles.

      Returns:
      The flag that enables the rule-based matching process of duplicate profiles.

    • hasMatchingRules

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

    • matchingRules

      public final List<MatchingRule> matchingRules()

      Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.

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

      Returns:
      Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.

    • status

      public final RuleBasedMatchingStatus status()

      PENDING

      • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

      IN_PROGRESS

      • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

      ACTIVE

      • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.

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

      Returns:
      PENDING

      • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

      IN_PROGRESS

      • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

      ACTIVE

      • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.

      See Also:

    • statusAsString

      public final String statusAsString()

      PENDING

      • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

      IN_PROGRESS

      • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

      ACTIVE

      • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.

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

      Returns:
      PENDING

      • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

      IN_PROGRESS

      • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

      ACTIVE

      • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.

      See Also:

    • maxAllowedRuleLevelForMerging

      public final Integer maxAllowedRuleLevelForMerging()

      MatchingRule

      Returns:
      MatchingRule

    • maxAllowedRuleLevelForMatching

      public final Integer maxAllowedRuleLevelForMatching()

      Indicates the maximum allowed rule level.

      Returns:
      Indicates the maximum allowed rule level.

    • attributeTypesSelector

      public final AttributeTypesSelector attributeTypesSelector()

      Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

      Returns:
      Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

    • conflictResolution

      public final ConflictResolution conflictResolution()
      Returns the value of the ConflictResolution property for this object.
      Returns:
      The value of the ConflictResolution property for this object.

    • exportingConfig

      public final ExportingConfig exportingConfig()
      Returns the value of the ExportingConfig property for this object.
      Returns:
      The value of the ExportingConfig property for this object.

    • toBuilder

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

    • builder

      public static RuleBasedMatchingResponse.Builder builder()

    • serializableBuilderClass

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