Class RuleBasedProperties
- java.lang.Object
-
- software.amazon.awssdk.services.entityresolution.model.RuleBasedProperties
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RuleBasedProperties.Builder,RuleBasedProperties>
@Generated("software.amazon.awssdk:codegen") public final class RuleBasedProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RuleBasedProperties.Builder,RuleBasedProperties>
An object which defines the list of matching rules to run in a matching workflow. RuleBasedProperties contain a
Rulesfield, which is a list of rule objects.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRuleBasedProperties.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributeMatchingModelattributeMatchingModel()The comparison type.StringattributeMatchingModelAsString()The comparison type.static RuleBasedProperties.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRules()For responses, this returns true if the service returned a value for the Rules property.MatchPurposematchPurpose()An indicator of whether to generate IDs and index the data or not.StringmatchPurposeAsString()An indicator of whether to generate IDs and index the data or not.List<Rule>rules()A list ofRuleobjects, each of which have fieldsRuleNameandMatchingKeys.List<SdkField<?>>sdkFields()static Class<? extends RuleBasedProperties.Builder>serializableBuilderClass()RuleBasedProperties.BuildertoBuilder()StringtoString()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
-
attributeMatchingModel
public final AttributeMatchingModel attributeMatchingModel()
The comparison type. You can either choose
ONE_TO_ONEorMANY_TO_MANYas theattributeMatchingModel.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 theEmailfield of Profile A and the value ofBusinessEmailfield of Profile B matches, the two profiles are matched on theEmailattribute type.If you choose
ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for theEmailattribute type, the system will only consider it a match if the value of theEmailfield of Profile A matches the value of theEmailfield of Profile B.If the service returns an enum value that is not available in the current SDK version,
attributeMatchingModelwill returnAttributeMatchingModel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromattributeMatchingModelAsString().- Returns:
- The comparison type. You can either choose
ONE_TO_ONEorMANY_TO_MANYas theattributeMatchingModel.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 theEmailfield of Profile A and the value ofBusinessEmailfield of Profile B matches, the two profiles are matched on theEmailattribute type.If you choose
ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for theEmailattribute type, the system will only consider it a match if the value of theEmailfield of Profile A matches the value of theEmailfield of Profile B. - See Also:
AttributeMatchingModel
-
attributeMatchingModelAsString
public final String attributeMatchingModelAsString()
The comparison type. You can either choose
ONE_TO_ONEorMANY_TO_MANYas theattributeMatchingModel.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 theEmailfield of Profile A and the value ofBusinessEmailfield of Profile B matches, the two profiles are matched on theEmailattribute type.If you choose
ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for theEmailattribute type, the system will only consider it a match if the value of theEmailfield of Profile A matches the value of theEmailfield of Profile B.If the service returns an enum value that is not available in the current SDK version,
attributeMatchingModelwill returnAttributeMatchingModel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromattributeMatchingModelAsString().- Returns:
- The comparison type. You can either choose
ONE_TO_ONEorMANY_TO_MANYas theattributeMatchingModel.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 theEmailfield of Profile A and the value ofBusinessEmailfield of Profile B matches, the two profiles are matched on theEmailattribute type.If you choose
ONE_TO_ONE, the system can only match attributes if the sub-types are an exact match. For example, for theEmailattribute type, the system will only consider it a match if the value of theEmailfield of Profile A matches the value of theEmailfield of Profile B. - See Also:
AttributeMatchingModel
-
matchPurpose
public final MatchPurpose matchPurpose()
An indicator of whether to generate IDs and index the data or not.
If you choose
IDENTIFIER_GENERATION, the process generates IDs and indexes the data.If you choose
INDEXING, the process indexes the data without generating IDs.If the service returns an enum value that is not available in the current SDK version,
matchPurposewill returnMatchPurpose.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommatchPurposeAsString().- Returns:
- An indicator of whether to generate IDs and index the data or not.
If you choose
IDENTIFIER_GENERATION, the process generates IDs and indexes the data.If you choose
INDEXING, the process indexes the data without generating IDs. - See Also:
MatchPurpose
-
matchPurposeAsString
public final String matchPurposeAsString()
An indicator of whether to generate IDs and index the data or not.
If you choose
IDENTIFIER_GENERATION, the process generates IDs and indexes the data.If you choose
INDEXING, the process indexes the data without generating IDs.If the service returns an enum value that is not available in the current SDK version,
matchPurposewill returnMatchPurpose.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommatchPurposeAsString().- Returns:
- An indicator of whether to generate IDs and index the data or not.
If you choose
IDENTIFIER_GENERATION, the process generates IDs and indexes the data.If you choose
INDEXING, the process indexes the data without generating IDs. - See Also:
MatchPurpose
-
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 theisEmpty()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()
A list of
Ruleobjects, each of which have fieldsRuleNameandMatchingKeys.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:
- A list of
Ruleobjects, each of which have fieldsRuleNameandMatchingKeys.
-
toBuilder
public RuleBasedProperties.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RuleBasedProperties.Builder,RuleBasedProperties>
-
builder
public static RuleBasedProperties.Builder builder()
-
serializableBuilderClass
public static Class<? extends RuleBasedProperties.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-