software.amazon.awssdk.services.mailmanager.model.RuleVerdictExpression Maven / Gradle / Ivy
/*
* 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.mailmanager.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.Consumer;
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;
/**
*
* A verdict expression is evaluated against verdicts of the email.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RuleVerdictExpression implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField EVALUATE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Evaluate")
.getter(getter(RuleVerdictExpression::evaluate)).setter(setter(Builder::evaluate))
.constructor(RuleVerdictToEvaluate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Evaluate").build()).build();
private static final SdkField OPERATOR_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Operator").getter(getter(RuleVerdictExpression::operatorAsString)).setter(setter(Builder::operator))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Operator").build()).build();
private static final SdkField> VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Values")
.getter(getter(RuleVerdictExpression::valuesAsStrings))
.setter(setter(Builder::valuesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Values").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(EVALUATE_FIELD,
OPERATOR_FIELD, VALUES_FIELD));
private static final long serialVersionUID = 1L;
private final RuleVerdictToEvaluate evaluate;
private final String operator;
private final List values;
private RuleVerdictExpression(BuilderImpl builder) {
this.evaluate = builder.evaluate;
this.operator = builder.operator;
this.values = builder.values;
}
/**
*
* The verdict to evaluate in a verdict condition expression.
*
*
* @return The verdict to evaluate in a verdict condition expression.
*/
public final RuleVerdictToEvaluate evaluate() {
return evaluate;
}
/**
*
* The matching operator for a verdict condition expression.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #operator} will
* return {@link RuleVerdictOperator#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #operatorAsString}.
*
*
* @return The matching operator for a verdict condition expression.
* @see RuleVerdictOperator
*/
public final RuleVerdictOperator operator() {
return RuleVerdictOperator.fromValue(operator);
}
/**
*
* The matching operator for a verdict condition expression.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #operator} will
* return {@link RuleVerdictOperator#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #operatorAsString}.
*
*
* @return The matching operator for a verdict condition expression.
* @see RuleVerdictOperator
*/
public final String operatorAsString() {
return operator;
}
/**
*
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple
* values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the
* NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts
* match the verdict of the email.
*
*
* 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 #hasValues} method.
*
*
* @return The values to match with the email's verdict using the given operator. For the EQUALS operator, if
* multiple values are given, the condition is deemed to match if any of the given verdicts match that of
* the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of
* none of the given verdicts match the verdict of the email.
*/
public final List values() {
return RuleVerdictValueListCopier.copyStringToEnum(values);
}
/**
* For responses, this returns true if the service returned a value for the Values 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 hasValues() {
return values != null && !(values instanceof SdkAutoConstructList);
}
/**
*
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple
* values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the
* NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts
* match the verdict of the email.
*
*
* 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 #hasValues} method.
*
*
* @return The values to match with the email's verdict using the given operator. For the EQUALS operator, if
* multiple values are given, the condition is deemed to match if any of the given verdicts match that of
* the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of
* none of the given verdicts match the verdict of the email.
*/
public final List valuesAsStrings() {
return values;
}
@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(evaluate());
hashCode = 31 * hashCode + Objects.hashCode(operatorAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasValues() ? valuesAsStrings() : 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 RuleVerdictExpression)) {
return false;
}
RuleVerdictExpression other = (RuleVerdictExpression) obj;
return Objects.equals(evaluate(), other.evaluate()) && Objects.equals(operatorAsString(), other.operatorAsString())
&& hasValues() == other.hasValues() && Objects.equals(valuesAsStrings(), other.valuesAsStrings());
}
/**
* 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("RuleVerdictExpression").add("Evaluate", evaluate()).add("Operator", operatorAsString())
.add("Values", hasValues() ? valuesAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Evaluate":
return Optional.ofNullable(clazz.cast(evaluate()));
case "Operator":
return Optional.ofNullable(clazz.cast(operatorAsString()));
case "Values":
return Optional.ofNullable(clazz.cast(valuesAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RuleVerdictExpression) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The verdict to evaluate in a verdict condition expression.
*
*
* @param evaluate
* The verdict to evaluate in a verdict condition expression.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder evaluate(RuleVerdictToEvaluate evaluate);
/**
*
* The verdict to evaluate in a verdict condition expression.
*
* This is a convenience method that creates an instance of the {@link RuleVerdictToEvaluate.Builder} avoiding
* the need to create one manually via {@link RuleVerdictToEvaluate#builder()}.
*
*
* When the {@link Consumer} completes, {@link RuleVerdictToEvaluate.Builder#build()} is called immediately and
* its result is passed to {@link #evaluate(RuleVerdictToEvaluate)}.
*
* @param evaluate
* a consumer that will call methods on {@link RuleVerdictToEvaluate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #evaluate(RuleVerdictToEvaluate)
*/
default Builder evaluate(Consumer evaluate) {
return evaluate(RuleVerdictToEvaluate.builder().applyMutation(evaluate).build());
}
/**
*
* The matching operator for a verdict condition expression.
*
*
* @param operator
* The matching operator for a verdict condition expression.
* @see RuleVerdictOperator
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleVerdictOperator
*/
Builder operator(String operator);
/**
*
* The matching operator for a verdict condition expression.
*
*
* @param operator
* The matching operator for a verdict condition expression.
* @see RuleVerdictOperator
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleVerdictOperator
*/
Builder operator(RuleVerdictOperator operator);
/**
*
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple
* values are given, the condition is deemed to match if any of the given verdicts match that of the email. For
* the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given
* verdicts match the verdict of the email.
*
*
* @param values
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if
* multiple values are given, the condition is deemed to match if any of the given verdicts match that of
* the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match
* of none of the given verdicts match the verdict of the email.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder valuesWithStrings(Collection values);
/**
*
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple
* values are given, the condition is deemed to match if any of the given verdicts match that of the email. For
* the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given
* verdicts match the verdict of the email.
*
*
* @param values
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if
* multiple values are given, the condition is deemed to match if any of the given verdicts match that of
* the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match
* of none of the given verdicts match the verdict of the email.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder valuesWithStrings(String... values);
/**
*
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple
* values are given, the condition is deemed to match if any of the given verdicts match that of the email. For
* the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given
* verdicts match the verdict of the email.
*
*
* @param values
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if
* multiple values are given, the condition is deemed to match if any of the given verdicts match that of
* the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match
* of none of the given verdicts match the verdict of the email.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Collection values);
/**
*
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple
* values are given, the condition is deemed to match if any of the given verdicts match that of the email. For
* the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given
* verdicts match the verdict of the email.
*
*
* @param values
* The values to match with the email's verdict using the given operator. For the EQUALS operator, if
* multiple values are given, the condition is deemed to match if any of the given verdicts match that of
* the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match
* of none of the given verdicts match the verdict of the email.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(RuleVerdict... values);
}
static final class BuilderImpl implements Builder {
private RuleVerdictToEvaluate evaluate;
private String operator;
private List values = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(RuleVerdictExpression model) {
evaluate(model.evaluate);
operator(model.operator);
valuesWithStrings(model.values);
}
public final RuleVerdictToEvaluate.Builder getEvaluate() {
return evaluate != null ? evaluate.toBuilder() : null;
}
public final void setEvaluate(RuleVerdictToEvaluate.BuilderImpl evaluate) {
this.evaluate = evaluate != null ? evaluate.build() : null;
}
@Override
public final Builder evaluate(RuleVerdictToEvaluate evaluate) {
this.evaluate = evaluate;
return this;
}
public final String getOperator() {
return operator;
}
public final void setOperator(String operator) {
this.operator = operator;
}
@Override
public final Builder operator(String operator) {
this.operator = operator;
return this;
}
@Override
public final Builder operator(RuleVerdictOperator operator) {
this.operator(operator == null ? null : operator.toString());
return this;
}
public final Collection getValues() {
if (values instanceof SdkAutoConstructList) {
return null;
}
return values;
}
public final void setValues(Collection values) {
this.values = RuleVerdictValueListCopier.copy(values);
}
@Override
public final Builder valuesWithStrings(Collection values) {
this.values = RuleVerdictValueListCopier.copy(values);
return this;
}
@Override
@SafeVarargs
public final Builder valuesWithStrings(String... values) {
valuesWithStrings(Arrays.asList(values));
return this;
}
@Override
public final Builder values(Collection values) {
this.values = RuleVerdictValueListCopier.copyEnumToString(values);
return this;
}
@Override
@SafeVarargs
public final Builder values(RuleVerdict... values) {
values(Arrays.asList(values));
return this;
}
@Override
public RuleVerdictExpression build() {
return new RuleVerdictExpression(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}