software.amazon.awssdk.services.customerprofiles.model.MatchingRule Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of customerprofiles Show documentation
Show all versions of customerprofiles Show documentation
The AWS Java SDK for Customer Profiles module holds the client classes that are used for
communicating with Customer Profiles.
/*
* Copyright 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 software.amazon.awssdk.services.customerprofiles.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Specifies how does the rule-based matching process should match profiles. You can choose from the following
* attributes to build the matching Rule:
*
*
* -
*
* AccountNumber
*
*
* -
*
* Address.Address
*
*
* -
*
* Address.City
*
*
* -
*
* Address.Country
*
*
* -
*
* Address.County
*
*
* -
*
* Address.PostalCode
*
*
* -
*
* Address.State
*
*
* -
*
* Address.Province
*
*
* -
*
* BirthDate
*
*
* -
*
* BusinessName
*
*
* -
*
* EmailAddress
*
*
* -
*
* FirstName
*
*
* -
*
* Gender
*
*
* -
*
* LastName
*
*
* -
*
* MiddleName
*
*
* -
*
* PhoneNumber
*
*
* -
*
* Any customized profile attributes that start with the Attributes
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MatchingRule implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> RULE_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Rule")
.getter(getter(MatchingRule::rule))
.setter(setter(Builder::rule))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Rule").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RULE_FIELD));
private static final long serialVersionUID = 1L;
private final List rule;
private MatchingRule(BuilderImpl builder) {
this.rule = builder.rule;
}
/**
* For responses, this returns true if the service returned a value for the Rule property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasRule() {
return rule != null && !(rule instanceof SdkAutoConstructList);
}
/**
*
* A single rule level of the MatchRules. Configures how the rule-based matching process should match
* profiles.
*
*
* 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 {@link #hasRule} method.
*
*
* @return A single rule level of the MatchRules. Configures how the rule-based matching process should
* match profiles.
*/
public final List rule() {
return rule;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasRule() ? rule() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MatchingRule)) {
return false;
}
MatchingRule other = (MatchingRule) obj;
return hasRule() == other.hasRule() && Objects.equals(rule(), other.rule());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("MatchingRule").add("Rule", hasRule() ? rule() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Rule":
return Optional.ofNullable(clazz.cast(rule()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MatchingRule) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A single rule level of the MatchRules. Configures how the rule-based matching process should
* match profiles.
*
*
* @param rule
* A single rule level of the MatchRules. Configures how the rule-based matching process
* should match profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rule(Collection rule);
/**
*
* A single rule level of the MatchRules. Configures how the rule-based matching process should
* match profiles.
*
*
* @param rule
* A single rule level of the MatchRules. Configures how the rule-based matching process
* should match profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rule(String... rule);
}
static final class BuilderImpl implements Builder {
private List rule = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MatchingRule model) {
rule(model.rule);
}
public final Collection getRule() {
if (rule instanceof SdkAutoConstructList) {
return null;
}
return rule;
}
public final void setRule(Collection rule) {
this.rule = MatchingRuleAttributeListCopier.copy(rule);
}
@Override
public final Builder rule(Collection rule) {
this.rule = MatchingRuleAttributeListCopier.copy(rule);
return this;
}
@Override
@SafeVarargs
public final Builder rule(String... rule) {
rule(Arrays.asList(rule));
return this;
}
@Override
public MatchingRule build() {
return new MatchingRule(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}