com.amazonaws.services.customerprofiles.model.RuleBasedMatchingResponse Maven / Gradle / Ivy
Show all versions of aws-java-sdk-customerprofiles Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.customerprofiles.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The response of the Rule-based matching request.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RuleBasedMatchingResponse implements Serializable, Cloneable, StructuredPojo {
/**
*
* The flag that enables the rule-based matching process of duplicate profiles.
*
*/
private Boolean enabled;
/**
*
* Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
*
*/
private java.util.List matchingRules;
/**
*
* 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.
*
*
*
*/
private String status;
/**
*
* MatchingRule
*
*/
private Integer maxAllowedRuleLevelForMerging;
/**
*
* Indicates the maximum allowed rule level.
*
*/
private Integer maxAllowedRuleLevelForMatching;
/**
*
* Configures information about the AttributeTypesSelector where the rule-based identity resolution
* uses to match profiles.
*
*/
private AttributeTypesSelector attributeTypesSelector;
private ConflictResolution conflictResolution;
private ExportingConfig exportingConfig;
/**
*
* The flag that enables the rule-based matching process of duplicate profiles.
*
*
* @param enabled
* The flag that enables the rule-based matching process of duplicate profiles.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
*
* The flag that enables the rule-based matching process of duplicate profiles.
*
*
* @return The flag that enables the rule-based matching process of duplicate profiles.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
*
* The flag that enables the rule-based matching process of duplicate profiles.
*
*
* @param enabled
* The flag that enables the rule-based matching process of duplicate profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleBasedMatchingResponse withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* The flag that enables the rule-based matching process of duplicate profiles.
*
*
* @return The flag that enables the rule-based matching process of duplicate profiles.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*
* Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
*
*
* @return Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
*/
public java.util.List getMatchingRules() {
return matchingRules;
}
/**
*
* Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
*
*
* @param matchingRules
* Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
*/
public void setMatchingRules(java.util.Collection matchingRules) {
if (matchingRules == null) {
this.matchingRules = null;
return;
}
this.matchingRules = new java.util.ArrayList(matchingRules);
}
/**
*
* Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMatchingRules(java.util.Collection)} or {@link #withMatchingRules(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param matchingRules
* Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleBasedMatchingResponse withMatchingRules(MatchingRule... matchingRules) {
if (this.matchingRules == null) {
setMatchingRules(new java.util.ArrayList(matchingRules.length));
}
for (MatchingRule ele : matchingRules) {
this.matchingRules.add(ele);
}
return this;
}
/**
*
* Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
*
*
* @param matchingRules
* Configures how the rule-based matching process should match profiles. You can have up to 15
* MatchingRule in the MatchingRules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleBasedMatchingResponse withMatchingRules(java.util.Collection matchingRules) {
setMatchingRules(matchingRules);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see RuleBasedMatchingStatus
*/
public void setStatus(String status) {
this.status = 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.
*
*
*
*
* @return 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 RuleBasedMatchingStatus
*/
public String getStatus() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleBasedMatchingStatus
*/
public RuleBasedMatchingResponse withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleBasedMatchingStatus
*/
public RuleBasedMatchingResponse withStatus(RuleBasedMatchingStatus status) {
this.status = status.toString();
return this;
}
/**
*
* MatchingRule
*
*
* @param maxAllowedRuleLevelForMerging
*
* MatchingRule
*/
public void setMaxAllowedRuleLevelForMerging(Integer maxAllowedRuleLevelForMerging) {
this.maxAllowedRuleLevelForMerging = maxAllowedRuleLevelForMerging;
}
/**
*
* MatchingRule
*
*
* @return MatchingRule
*
*/
public Integer getMaxAllowedRuleLevelForMerging() {
return this.maxAllowedRuleLevelForMerging;
}
/**
*
* MatchingRule
*
*
* @param maxAllowedRuleLevelForMerging
*
* MatchingRule
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleBasedMatchingResponse withMaxAllowedRuleLevelForMerging(Integer maxAllowedRuleLevelForMerging) {
setMaxAllowedRuleLevelForMerging(maxAllowedRuleLevelForMerging);
return this;
}
/**
*
* Indicates the maximum allowed rule level.
*
*
* @param maxAllowedRuleLevelForMatching
* Indicates the maximum allowed rule level.
*/
public void setMaxAllowedRuleLevelForMatching(Integer maxAllowedRuleLevelForMatching) {
this.maxAllowedRuleLevelForMatching = maxAllowedRuleLevelForMatching;
}
/**
*
* Indicates the maximum allowed rule level.
*
*
* @return Indicates the maximum allowed rule level.
*/
public Integer getMaxAllowedRuleLevelForMatching() {
return this.maxAllowedRuleLevelForMatching;
}
/**
*
* Indicates the maximum allowed rule level.
*
*
* @param maxAllowedRuleLevelForMatching
* Indicates the maximum allowed rule level.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleBasedMatchingResponse withMaxAllowedRuleLevelForMatching(Integer maxAllowedRuleLevelForMatching) {
setMaxAllowedRuleLevelForMatching(maxAllowedRuleLevelForMatching);
return this;
}
/**
*
* Configures information about the AttributeTypesSelector where the rule-based identity resolution
* uses to match profiles.
*
*
* @param attributeTypesSelector
* Configures information about the AttributeTypesSelector where the rule-based identity
* resolution uses to match profiles.
*/
public void setAttributeTypesSelector(AttributeTypesSelector attributeTypesSelector) {
this.attributeTypesSelector = attributeTypesSelector;
}
/**
*
* Configures information about the AttributeTypesSelector where the rule-based identity resolution
* uses to match profiles.
*
*
* @return Configures information about the AttributeTypesSelector where the rule-based identity
* resolution uses to match profiles.
*/
public AttributeTypesSelector getAttributeTypesSelector() {
return this.attributeTypesSelector;
}
/**
*
* Configures information about the AttributeTypesSelector where the rule-based identity resolution
* uses to match profiles.
*
*
* @param attributeTypesSelector
* Configures information about the AttributeTypesSelector where the rule-based identity
* resolution uses to match profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleBasedMatchingResponse withAttributeTypesSelector(AttributeTypesSelector attributeTypesSelector) {
setAttributeTypesSelector(attributeTypesSelector);
return this;
}
/**
* @param conflictResolution
*/
public void setConflictResolution(ConflictResolution conflictResolution) {
this.conflictResolution = conflictResolution;
}
/**
* @return
*/
public ConflictResolution getConflictResolution() {
return this.conflictResolution;
}
/**
* @param conflictResolution
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleBasedMatchingResponse withConflictResolution(ConflictResolution conflictResolution) {
setConflictResolution(conflictResolution);
return this;
}
/**
* @param exportingConfig
*/
public void setExportingConfig(ExportingConfig exportingConfig) {
this.exportingConfig = exportingConfig;
}
/**
* @return
*/
public ExportingConfig getExportingConfig() {
return this.exportingConfig;
}
/**
* @param exportingConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleBasedMatchingResponse withExportingConfig(ExportingConfig exportingConfig) {
setExportingConfig(exportingConfig);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled()).append(",");
if (getMatchingRules() != null)
sb.append("MatchingRules: ").append(getMatchingRules()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getMaxAllowedRuleLevelForMerging() != null)
sb.append("MaxAllowedRuleLevelForMerging: ").append(getMaxAllowedRuleLevelForMerging()).append(",");
if (getMaxAllowedRuleLevelForMatching() != null)
sb.append("MaxAllowedRuleLevelForMatching: ").append(getMaxAllowedRuleLevelForMatching()).append(",");
if (getAttributeTypesSelector() != null)
sb.append("AttributeTypesSelector: ").append(getAttributeTypesSelector()).append(",");
if (getConflictResolution() != null)
sb.append("ConflictResolution: ").append(getConflictResolution()).append(",");
if (getExportingConfig() != null)
sb.append("ExportingConfig: ").append(getExportingConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RuleBasedMatchingResponse == false)
return false;
RuleBasedMatchingResponse other = (RuleBasedMatchingResponse) obj;
if (other.getEnabled() == null ^ this.getEnabled() == null)
return false;
if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false)
return false;
if (other.getMatchingRules() == null ^ this.getMatchingRules() == null)
return false;
if (other.getMatchingRules() != null && other.getMatchingRules().equals(this.getMatchingRules()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getMaxAllowedRuleLevelForMerging() == null ^ this.getMaxAllowedRuleLevelForMerging() == null)
return false;
if (other.getMaxAllowedRuleLevelForMerging() != null
&& other.getMaxAllowedRuleLevelForMerging().equals(this.getMaxAllowedRuleLevelForMerging()) == false)
return false;
if (other.getMaxAllowedRuleLevelForMatching() == null ^ this.getMaxAllowedRuleLevelForMatching() == null)
return false;
if (other.getMaxAllowedRuleLevelForMatching() != null
&& other.getMaxAllowedRuleLevelForMatching().equals(this.getMaxAllowedRuleLevelForMatching()) == false)
return false;
if (other.getAttributeTypesSelector() == null ^ this.getAttributeTypesSelector() == null)
return false;
if (other.getAttributeTypesSelector() != null && other.getAttributeTypesSelector().equals(this.getAttributeTypesSelector()) == false)
return false;
if (other.getConflictResolution() == null ^ this.getConflictResolution() == null)
return false;
if (other.getConflictResolution() != null && other.getConflictResolution().equals(this.getConflictResolution()) == false)
return false;
if (other.getExportingConfig() == null ^ this.getExportingConfig() == null)
return false;
if (other.getExportingConfig() != null && other.getExportingConfig().equals(this.getExportingConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode());
hashCode = prime * hashCode + ((getMatchingRules() == null) ? 0 : getMatchingRules().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getMaxAllowedRuleLevelForMerging() == null) ? 0 : getMaxAllowedRuleLevelForMerging().hashCode());
hashCode = prime * hashCode + ((getMaxAllowedRuleLevelForMatching() == null) ? 0 : getMaxAllowedRuleLevelForMatching().hashCode());
hashCode = prime * hashCode + ((getAttributeTypesSelector() == null) ? 0 : getAttributeTypesSelector().hashCode());
hashCode = prime * hashCode + ((getConflictResolution() == null) ? 0 : getConflictResolution().hashCode());
hashCode = prime * hashCode + ((getExportingConfig() == null) ? 0 : getExportingConfig().hashCode());
return hashCode;
}
@Override
public RuleBasedMatchingResponse clone() {
try {
return (RuleBasedMatchingResponse) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.customerprofiles.model.transform.RuleBasedMatchingResponseMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}