Class RuleBasedProperties
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RuleBasedProperties.Builder,
RuleBasedProperties>
An object which defines the list of matching rules to run and has a field Rules
, which is a list of rule
objects.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AttributeMatchingModel
The comparison type.final String
The comparison type.static RuleBasedProperties.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasRules()
For responses, this returns true if the service returned a value for the Rules property.rules()
A list ofRule
objects, each of which have fieldsRuleName
andMatchingKeys
.static Class
<? extends RuleBasedProperties.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
attributeMatchingModel
The comparison type. You can either choose
ONE_TO_ONE
orMANY_TO_MANY
as the AttributeMatchingModel. When choosingMANY_TO_MANY
, the system can match attributes across the sub-types of an attribute type. For example, if the value of theEmail
field of Profile A and the value ofBusinessEmail
field of Profile B matches, the two profiles are matched on theEmail
type. When choosingONE_TO_ONE
,the system can only match if the sub-types are exact matches. For example, only when the value of theEmail
field of Profile A and the value of theEmail
field of Profile B matches, the two profiles are matched on theEmail
type.If the service returns an enum value that is not available in the current SDK version,
attributeMatchingModel
will 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_ONE
orMANY_TO_MANY
as the AttributeMatchingModel. When choosingMANY_TO_MANY
, the system can match attributes across the sub-types of an attribute type. For example, if the value of theEmail
field of Profile A and the value ofBusinessEmail
field of Profile B matches, the two profiles are matched on theEmail
type. When choosingONE_TO_ONE
,the system can only match if the sub-types are exact matches. For example, only when the value of theEmail
field of Profile A and the value of theEmail
field of Profile B matches, the two profiles are matched on theEmail
type. - See Also:
-
attributeMatchingModelAsString
The comparison type. You can either choose
ONE_TO_ONE
orMANY_TO_MANY
as the AttributeMatchingModel. When choosingMANY_TO_MANY
, the system can match attributes across the sub-types of an attribute type. For example, if the value of theEmail
field of Profile A and the value ofBusinessEmail
field of Profile B matches, the two profiles are matched on theEmail
type. When choosingONE_TO_ONE
,the system can only match if the sub-types are exact matches. For example, only when the value of theEmail
field of Profile A and the value of theEmail
field of Profile B matches, the two profiles are matched on theEmail
type.If the service returns an enum value that is not available in the current SDK version,
attributeMatchingModel
will 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_ONE
orMANY_TO_MANY
as the AttributeMatchingModel. When choosingMANY_TO_MANY
, the system can match attributes across the sub-types of an attribute type. For example, if the value of theEmail
field of Profile A and the value ofBusinessEmail
field of Profile B matches, the two profiles are matched on theEmail
type. When choosingONE_TO_ONE
,the system can only match if the sub-types are exact matches. For example, only when the value of theEmail
field of Profile A and the value of theEmail
field of Profile B matches, the two profiles are matched on theEmail
type. - 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 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
A list of
Rule
objects, each of which have fieldsRuleName
andMatchingKeys
.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
Rule
objects, each of which have fieldsRuleName
andMatchingKeys
.
-
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 interfaceToCopyableBuilder<RuleBasedProperties.Builder,
RuleBasedProperties> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-