software.amazon.awssdk.services.ses.model.MessageDsn Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ses Show documentation
Show all versions of ses Show documentation
The AWS Java SDK for Amazon SES module holds the client classes that are used for communicating with
Amazon Simple Email
Service
/*
* 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.beans.Transient;
import java.io.Serializable;
import java.time.Instant;
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;
/**
*
* Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES
* receives on your behalf bounces.
*
*
* For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MessageDsn implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField REPORTING_MTA_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReportingMta").getter(getter(MessageDsn::reportingMta)).setter(setter(Builder::reportingMta))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReportingMta").build()).build();
private static final SdkField ARRIVAL_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("ArrivalDate").getter(getter(MessageDsn::arrivalDate)).setter(setter(Builder::arrivalDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ArrivalDate").build()).build();
private static final SdkField> EXTENSION_FIELDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ExtensionFields")
.getter(getter(MessageDsn::extensionFields))
.setter(setter(Builder::extensionFields))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExtensionFields").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ExtensionField::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REPORTING_MTA_FIELD,
ARRIVAL_DATE_FIELD, EXTENSION_FIELDS_FIELD));
private static final long serialVersionUID = 1L;
private final String reportingMta;
private final Instant arrivalDate;
private final List extensionFields;
private MessageDsn(BuilderImpl builder) {
this.reportingMta = builder.reportingMta;
this.arrivalDate = builder.arrivalDate;
this.extensionFields = builder.extensionFields;
}
/**
*
* The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value
* is dns; inbound-smtp.[region].amazonaws.com.
*
*
* @return The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The
* default value is dns; inbound-smtp.[region].amazonaws.com.
*/
public final String reportingMta() {
return reportingMta;
}
/**
*
* When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
*
*
* @return When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
*/
public final Instant arrivalDate() {
return arrivalDate;
}
/**
* For responses, this returns true if the service returned a value for the ExtensionFields 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 hasExtensionFields() {
return extensionFields != null && !(extensionFields instanceof SdkAutoConstructList);
}
/**
*
* Additional X-headers to include in the DSN.
*
*
* 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 #hasExtensionFields} method.
*
*
* @return Additional X-headers to include in the DSN.
*/
public final List extensionFields() {
return extensionFields;
}
@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(reportingMta());
hashCode = 31 * hashCode + Objects.hashCode(arrivalDate());
hashCode = 31 * hashCode + Objects.hashCode(hasExtensionFields() ? extensionFields() : 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 MessageDsn)) {
return false;
}
MessageDsn other = (MessageDsn) obj;
return Objects.equals(reportingMta(), other.reportingMta()) && Objects.equals(arrivalDate(), other.arrivalDate())
&& hasExtensionFields() == other.hasExtensionFields()
&& Objects.equals(extensionFields(), other.extensionFields());
}
/**
* 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("MessageDsn").add("ReportingMta", reportingMta()).add("ArrivalDate", arrivalDate())
.add("ExtensionFields", hasExtensionFields() ? extensionFields() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReportingMta":
return Optional.ofNullable(clazz.cast(reportingMta()));
case "ArrivalDate":
return Optional.ofNullable(clazz.cast(arrivalDate()));
case "ExtensionFields":
return Optional.ofNullable(clazz.cast(extensionFields()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MessageDsn) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default
* value is dns; inbound-smtp.[region].amazonaws.com.
*
*
* @param reportingMta
* The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The
* default value is dns; inbound-smtp.[region].amazonaws.com.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reportingMta(String reportingMta);
/**
*
* When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
*
*
* @param arrivalDate
* When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arrivalDate(Instant arrivalDate);
/**
*
* Additional X-headers to include in the DSN.
*
*
* @param extensionFields
* Additional X-headers to include in the DSN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder extensionFields(Collection extensionFields);
/**
*
* Additional X-headers to include in the DSN.
*
*
* @param extensionFields
* Additional X-headers to include in the DSN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder extensionFields(ExtensionField... extensionFields);
/**
*
* Additional X-headers to include in the DSN.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #extensionFields(List)}.
*
* @param extensionFields
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #extensionFields(List)
*/
Builder extensionFields(Consumer... extensionFields);
}
static final class BuilderImpl implements Builder {
private String reportingMta;
private Instant arrivalDate;
private List extensionFields = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MessageDsn model) {
reportingMta(model.reportingMta);
arrivalDate(model.arrivalDate);
extensionFields(model.extensionFields);
}
public final String getReportingMta() {
return reportingMta;
}
public final void setReportingMta(String reportingMta) {
this.reportingMta = reportingMta;
}
@Override
@Transient
public final Builder reportingMta(String reportingMta) {
this.reportingMta = reportingMta;
return this;
}
public final Instant getArrivalDate() {
return arrivalDate;
}
public final void setArrivalDate(Instant arrivalDate) {
this.arrivalDate = arrivalDate;
}
@Override
@Transient
public final Builder arrivalDate(Instant arrivalDate) {
this.arrivalDate = arrivalDate;
return this;
}
public final List getExtensionFields() {
List result = ExtensionFieldListCopier.copyToBuilder(this.extensionFields);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setExtensionFields(Collection extensionFields) {
this.extensionFields = ExtensionFieldListCopier.copyFromBuilder(extensionFields);
}
@Override
@Transient
public final Builder extensionFields(Collection extensionFields) {
this.extensionFields = ExtensionFieldListCopier.copy(extensionFields);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder extensionFields(ExtensionField... extensionFields) {
extensionFields(Arrays.asList(extensionFields));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder extensionFields(Consumer... extensionFields) {
extensionFields(Stream.of(extensionFields).map(c -> ExtensionField.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public MessageDsn build() {
return new MessageDsn(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy