software.amazon.awssdk.services.ses.model.ReceiptRule Maven / Gradle / Ivy
Show all versions of ses Show documentation
/*
* 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.ses.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 java.util.stream.Collectors;
import java.util.stream.Stream;
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;
/**
*
* Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or
* more email addresses or domains that you own.
*
*
* Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains
* match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the
* message.
*
*
* For information about setting up receipt rules, see the Amazon SES
* Developer Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ReceiptRule implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ReceiptRule::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Enabled").getter(getter(ReceiptRule::enabled)).setter(setter(Builder::enabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Enabled").build()).build();
private static final SdkField TLS_POLICY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TlsPolicy").getter(getter(ReceiptRule::tlsPolicyAsString)).setter(setter(Builder::tlsPolicy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TlsPolicy").build()).build();
private static final SdkField> RECIPIENTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Recipients")
.getter(getter(ReceiptRule::recipients))
.setter(setter(Builder::recipients))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Recipients").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 SdkField> ACTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Actions")
.getter(getter(ReceiptRule::actions))
.setter(setter(Builder::actions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Actions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ReceiptAction::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SCAN_ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ScanEnabled").getter(getter(ReceiptRule::scanEnabled)).setter(setter(Builder::scanEnabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScanEnabled").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, ENABLED_FIELD,
TLS_POLICY_FIELD, RECIPIENTS_FIELD, ACTIONS_FIELD, SCAN_ENABLED_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final Boolean enabled;
private final String tlsPolicy;
private final List recipients;
private final List actions;
private final Boolean scanEnabled;
private ReceiptRule(BuilderImpl builder) {
this.name = builder.name;
this.enabled = builder.enabled;
this.tlsPolicy = builder.tlsPolicy;
this.recipients = builder.recipients;
this.actions = builder.actions;
this.scanEnabled = builder.scanEnabled;
}
/**
*
* The name of the receipt rule. The name must meet the following requirements:
*
*
* -
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
*
*
* -
*
* Start and end with a letter or number.
*
*
* -
*
* Contain 64 characters or fewer.
*
*
*
*
* @return The name of the receipt rule. The name must meet the following requirements:
*
* -
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
*
*
* -
*
* Start and end with a letter or number.
*
*
* -
*
* Contain 64 characters or fewer.
*
*
*/
public final String name() {
return name;
}
/**
*
* If true, the receipt rule is active. The default value is false.
*
*
* @return If true, the receipt rule is active. The default value is false.
*/
public final Boolean enabled() {
return enabled;
}
/**
*
* Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with
* Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that
* are not received over TLS. The default is Optional.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #tlsPolicy} will
* return {@link TlsPolicy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #tlsPolicyAsString}.
*
*
* @return Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted
* with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces
* emails that are not received over TLS. The default is Optional.
* @see TlsPolicy
*/
public final TlsPolicy tlsPolicy() {
return TlsPolicy.fromValue(tlsPolicy);
}
/**
*
* Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with
* Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that
* are not received over TLS. The default is Optional.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #tlsPolicy} will
* return {@link TlsPolicy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #tlsPolicyAsString}.
*
*
* @return Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted
* with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces
* emails that are not received over TLS. The default is Optional.
* @see TlsPolicy
*/
public final String tlsPolicyAsString() {
return tlsPolicy;
}
/**
* For responses, this returns true if the service returned a value for the Recipients 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 hasRecipients() {
return recipients != null && !(recipients instanceof SdkAutoConstructList);
}
/**
*
* The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this
* rule matches all recipients on all verified domains.
*
*
* 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 #hasRecipients} method.
*
*
* @return The recipient domains and email addresses that the receipt rule applies to. If this field is not
* specified, this rule matches all recipients on all verified domains.
*/
public final List recipients() {
return recipients;
}
/**
* For responses, this returns true if the service returned a value for the Actions 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 hasActions() {
return actions != null && !(actions instanceof SdkAutoConstructList);
}
/**
*
* An ordered list of actions to perform on messages that match at least one of the recipient email addresses or
* domains specified in the receipt rule.
*
*
* 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 #hasActions} method.
*
*
* @return An ordered list of actions to perform on messages that match at least one of the recipient email
* addresses or domains specified in the receipt rule.
*/
public final List actions() {
return actions;
}
/**
*
* If true, then messages that this receipt rule applies to are scanned for spam and viruses. The
* default value is false.
*
*
* @return If true, then messages that this receipt rule applies to are scanned for spam and viruses.
* The default value is false.
*/
public final Boolean scanEnabled() {
return scanEnabled;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(enabled());
hashCode = 31 * hashCode + Objects.hashCode(tlsPolicyAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasRecipients() ? recipients() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasActions() ? actions() : null);
hashCode = 31 * hashCode + Objects.hashCode(scanEnabled());
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 ReceiptRule)) {
return false;
}
ReceiptRule other = (ReceiptRule) obj;
return Objects.equals(name(), other.name()) && Objects.equals(enabled(), other.enabled())
&& Objects.equals(tlsPolicyAsString(), other.tlsPolicyAsString()) && hasRecipients() == other.hasRecipients()
&& Objects.equals(recipients(), other.recipients()) && hasActions() == other.hasActions()
&& Objects.equals(actions(), other.actions()) && Objects.equals(scanEnabled(), other.scanEnabled());
}
/**
* 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("ReceiptRule").add("Name", name()).add("Enabled", enabled())
.add("TlsPolicy", tlsPolicyAsString()).add("Recipients", hasRecipients() ? recipients() : null)
.add("Actions", hasActions() ? actions() : null).add("ScanEnabled", scanEnabled()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Enabled":
return Optional.ofNullable(clazz.cast(enabled()));
case "TlsPolicy":
return Optional.ofNullable(clazz.cast(tlsPolicyAsString()));
case "Recipients":
return Optional.ofNullable(clazz.cast(recipients()));
case "Actions":
return Optional.ofNullable(clazz.cast(actions()));
case "ScanEnabled":
return Optional.ofNullable(clazz.cast(scanEnabled()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ReceiptRule) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the receipt rule. The name must meet the following requirements:
*
*
* -
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
*
*
* -
*
* Start and end with a letter or number.
*
*
* -
*
* Contain 64 characters or fewer.
*
*
*
*
* @param name
* The name of the receipt rule. The name must meet the following requirements:
*
* -
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
*
*
* -
*
* Start and end with a letter or number.
*
*
* -
*
* Contain 64 characters or fewer.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* If true, the receipt rule is active. The default value is false.
*
*
* @param enabled
* If true, the receipt rule is active. The default value is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enabled(Boolean enabled);
/**
*
* Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with
* Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails
* that are not received over TLS. The default is Optional.
*
*
* @param tlsPolicy
* Specifies whether Amazon SES should require that incoming email is delivered over a connection
* encrypted with Transport Layer Security (TLS). If this parameter is set to Require,
* Amazon SES bounces emails that are not received over TLS. The default is Optional.
* @see TlsPolicy
* @return Returns a reference to this object so that method calls can be chained together.
* @see TlsPolicy
*/
Builder tlsPolicy(String tlsPolicy);
/**
*
* Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with
* Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails
* that are not received over TLS. The default is Optional.
*
*
* @param tlsPolicy
* Specifies whether Amazon SES should require that incoming email is delivered over a connection
* encrypted with Transport Layer Security (TLS). If this parameter is set to Require,
* Amazon SES bounces emails that are not received over TLS. The default is Optional.
* @see TlsPolicy
* @return Returns a reference to this object so that method calls can be chained together.
* @see TlsPolicy
*/
Builder tlsPolicy(TlsPolicy tlsPolicy);
/**
*
* The recipient domains and email addresses that the receipt rule applies to. If this field is not specified,
* this rule matches all recipients on all verified domains.
*
*
* @param recipients
* The recipient domains and email addresses that the receipt rule applies to. If this field is not
* specified, this rule matches all recipients on all verified domains.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recipients(Collection recipients);
/**
*
* The recipient domains and email addresses that the receipt rule applies to. If this field is not specified,
* this rule matches all recipients on all verified domains.
*
*
* @param recipients
* The recipient domains and email addresses that the receipt rule applies to. If this field is not
* specified, this rule matches all recipients on all verified domains.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recipients(String... recipients);
/**
*
* An ordered list of actions to perform on messages that match at least one of the recipient email addresses or
* domains specified in the receipt rule.
*
*
* @param actions
* An ordered list of actions to perform on messages that match at least one of the recipient email
* addresses or domains specified in the receipt rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(Collection actions);
/**
*
* An ordered list of actions to perform on messages that match at least one of the recipient email addresses or
* domains specified in the receipt rule.
*
*
* @param actions
* An ordered list of actions to perform on messages that match at least one of the recipient email
* addresses or domains specified in the receipt rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder actions(ReceiptAction... actions);
/**
*
* An ordered list of actions to perform on messages that match at least one of the recipient email addresses or
* domains specified in the receipt rule.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ses.model.ReceiptAction.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ses.model.ReceiptAction#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ses.model.ReceiptAction.Builder#build()} is called immediately and its
* result is passed to {@link #actions(List)}.
*
* @param actions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ses.model.ReceiptAction.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #actions(java.util.Collection)
*/
Builder actions(Consumer... actions);
/**
*
* If true, then messages that this receipt rule applies to are scanned for spam and viruses. The
* default value is false.
*
*
* @param scanEnabled
* If true, then messages that this receipt rule applies to are scanned for spam and
* viruses. The default value is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scanEnabled(Boolean scanEnabled);
}
static final class BuilderImpl implements Builder {
private String name;
private Boolean enabled;
private String tlsPolicy;
private List recipients = DefaultSdkAutoConstructList.getInstance();
private List actions = DefaultSdkAutoConstructList.getInstance();
private Boolean scanEnabled;
private BuilderImpl() {
}
private BuilderImpl(ReceiptRule model) {
name(model.name);
enabled(model.enabled);
tlsPolicy(model.tlsPolicy);
recipients(model.recipients);
actions(model.actions);
scanEnabled(model.scanEnabled);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final Boolean getEnabled() {
return enabled;
}
public final void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
@Override
public final Builder enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
public final String getTlsPolicy() {
return tlsPolicy;
}
public final void setTlsPolicy(String tlsPolicy) {
this.tlsPolicy = tlsPolicy;
}
@Override
public final Builder tlsPolicy(String tlsPolicy) {
this.tlsPolicy = tlsPolicy;
return this;
}
@Override
public final Builder tlsPolicy(TlsPolicy tlsPolicy) {
this.tlsPolicy(tlsPolicy == null ? null : tlsPolicy.toString());
return this;
}
public final Collection getRecipients() {
if (recipients instanceof SdkAutoConstructList) {
return null;
}
return recipients;
}
public final void setRecipients(Collection recipients) {
this.recipients = RecipientsListCopier.copy(recipients);
}
@Override
public final Builder recipients(Collection recipients) {
this.recipients = RecipientsListCopier.copy(recipients);
return this;
}
@Override
@SafeVarargs
public final Builder recipients(String... recipients) {
recipients(Arrays.asList(recipients));
return this;
}
public final List getActions() {
List result = ReceiptActionsListCopier.copyToBuilder(this.actions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setActions(Collection actions) {
this.actions = ReceiptActionsListCopier.copyFromBuilder(actions);
}
@Override
public final Builder actions(Collection actions) {
this.actions = ReceiptActionsListCopier.copy(actions);
return this;
}
@Override
@SafeVarargs
public final Builder actions(ReceiptAction... actions) {
actions(Arrays.asList(actions));
return this;
}
@Override
@SafeVarargs
public final Builder actions(Consumer... actions) {
actions(Stream.of(actions).map(c -> ReceiptAction.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Boolean getScanEnabled() {
return scanEnabled;
}
public final void setScanEnabled(Boolean scanEnabled) {
this.scanEnabled = scanEnabled;
}
@Override
public final Builder scanEnabled(Boolean scanEnabled) {
this.scanEnabled = scanEnabled;
return this;
}
@Override
public ReceiptRule build() {
return new ReceiptRule(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}