Class IdMappingRuleBasedProperties

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

An object that defines the list of matching rules to run in an ID mapping workflow.

See Also:

  • Method Details

    • attributeMatchingModel

      public final AttributeMatchingModel attributeMatchingModel()

      The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

      If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

      If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

      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:
      The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

      If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

      If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

      See Also:

    • attributeMatchingModelAsString

      public final String attributeMatchingModelAsString()

      The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

      If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

      If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

      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:
      The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel.

      If you choose MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

      If you choose ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

      See Also:

    • recordMatchingModel

      public final RecordMatchingModel recordMatchingModel()

      The type of matching record that is allowed to be used in an ID mapping workflow.

      If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source can be matched to the same record in the target.

      If the value is set to MANY_SOURCE_TO_ONE_TARGET, multiple records in the source can be matched to one record in the target.

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

      Returns:
      The type of matching record that is allowed to be used in an ID mapping workflow.

      If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source can be matched to the same record in the target.

      If the value is set to MANY_SOURCE_TO_ONE_TARGET, multiple records in the source can be matched to one record in the target.

      See Also:

    • recordMatchingModelAsString

      public final String recordMatchingModelAsString()

      The type of matching record that is allowed to be used in an ID mapping workflow.

      If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source can be matched to the same record in the target.

      If the value is set to MANY_SOURCE_TO_ONE_TARGET, multiple records in the source can be matched to one record in the target.

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

      Returns:
      The type of matching record that is allowed to be used in an ID mapping workflow.

      If the value is set to ONE_SOURCE_TO_ONE_TARGET, only one record in the source can be matched to the same record in the target.

      If the value is set to MANY_SOURCE_TO_ONE_TARGET, multiple records in the source can be matched to one record in the target.

      See Also:

    • ruleDefinitionType

      public final IdMappingWorkflowRuleDefinitionType ruleDefinitionType()

      The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.

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

      Returns:
      The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.
      See Also:

    • ruleDefinitionTypeAsString

      public final String ruleDefinitionTypeAsString()

      The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.

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

      Returns:
      The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.
      See Also:

    • hasRules

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

    • rules

      public final List<Rule> rules()

      The rules that can be used for ID mapping.

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

      Returns:
      The rules that can be used for ID mapping.

    • toBuilder

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

    • builder

      public static IdMappingRuleBasedProperties.Builder builder()

    • serializableBuilderClass

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