software.amazon.awssdk.services.ses.model.Destination 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.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.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;
/**
*
* Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
*
*
*
* Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit
* ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an
* address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address
* (the part before the @ sign) nor in the "friendly from" name. If you want to use Unicode characters in the
* "friendly from" name, you must encode the "friendly from" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API.
* For more information about Punycode, see RFC 3492.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Destination implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> TO_ADDRESSES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ToAddresses")
.getter(getter(Destination::toAddresses))
.setter(setter(Builder::toAddresses))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ToAddresses").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> CC_ADDRESSES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CcAddresses")
.getter(getter(Destination::ccAddresses))
.setter(setter(Builder::ccAddresses))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CcAddresses").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> BCC_ADDRESSES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("BccAddresses")
.getter(getter(Destination::bccAddresses))
.setter(setter(Builder::bccAddresses))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BccAddresses").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(TO_ADDRESSES_FIELD,
CC_ADDRESSES_FIELD, BCC_ADDRESSES_FIELD));
private static final long serialVersionUID = 1L;
private final List toAddresses;
private final List ccAddresses;
private final List bccAddresses;
private Destination(BuilderImpl builder) {
this.toAddresses = builder.toAddresses;
this.ccAddresses = builder.ccAddresses;
this.bccAddresses = builder.bccAddresses;
}
/**
* For responses, this returns true if the service returned a value for the ToAddresses 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 hasToAddresses() {
return toAddresses != null && !(toAddresses instanceof SdkAutoConstructList);
}
/**
*
* The recipients to place on the To: line of the message.
*
*
* 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 #hasToAddresses} method.
*
*
* @return The recipients to place on the To: line of the message.
*/
public final List toAddresses() {
return toAddresses;
}
/**
* For responses, this returns true if the service returned a value for the CcAddresses 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 hasCcAddresses() {
return ccAddresses != null && !(ccAddresses instanceof SdkAutoConstructList);
}
/**
*
* The recipients to place on the CC: line of the message.
*
*
* 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 #hasCcAddresses} method.
*
*
* @return The recipients to place on the CC: line of the message.
*/
public final List ccAddresses() {
return ccAddresses;
}
/**
* For responses, this returns true if the service returned a value for the BccAddresses 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 hasBccAddresses() {
return bccAddresses != null && !(bccAddresses instanceof SdkAutoConstructList);
}
/**
*
* The recipients to place on the BCC: line of the message.
*
*
* 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 #hasBccAddresses} method.
*
*
* @return The recipients to place on the BCC: line of the message.
*/
public final List bccAddresses() {
return bccAddresses;
}
@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(hasToAddresses() ? toAddresses() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasCcAddresses() ? ccAddresses() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasBccAddresses() ? bccAddresses() : 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 Destination)) {
return false;
}
Destination other = (Destination) obj;
return hasToAddresses() == other.hasToAddresses() && Objects.equals(toAddresses(), other.toAddresses())
&& hasCcAddresses() == other.hasCcAddresses() && Objects.equals(ccAddresses(), other.ccAddresses())
&& hasBccAddresses() == other.hasBccAddresses() && Objects.equals(bccAddresses(), other.bccAddresses());
}
/**
* 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("Destination").add("ToAddresses", hasToAddresses() ? toAddresses() : null)
.add("CcAddresses", hasCcAddresses() ? ccAddresses() : null)
.add("BccAddresses", hasBccAddresses() ? bccAddresses() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ToAddresses":
return Optional.ofNullable(clazz.cast(toAddresses()));
case "CcAddresses":
return Optional.ofNullable(clazz.cast(ccAddresses()));
case "BccAddresses":
return Optional.ofNullable(clazz.cast(bccAddresses()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Destination) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The recipients to place on the To: line of the message.
*
*
* @param toAddresses
* The recipients to place on the To: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder toAddresses(Collection toAddresses);
/**
*
* The recipients to place on the To: line of the message.
*
*
* @param toAddresses
* The recipients to place on the To: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder toAddresses(String... toAddresses);
/**
*
* The recipients to place on the CC: line of the message.
*
*
* @param ccAddresses
* The recipients to place on the CC: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ccAddresses(Collection ccAddresses);
/**
*
* The recipients to place on the CC: line of the message.
*
*
* @param ccAddresses
* The recipients to place on the CC: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ccAddresses(String... ccAddresses);
/**
*
* The recipients to place on the BCC: line of the message.
*
*
* @param bccAddresses
* The recipients to place on the BCC: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bccAddresses(Collection bccAddresses);
/**
*
* The recipients to place on the BCC: line of the message.
*
*
* @param bccAddresses
* The recipients to place on the BCC: line of the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bccAddresses(String... bccAddresses);
}
static final class BuilderImpl implements Builder {
private List toAddresses = DefaultSdkAutoConstructList.getInstance();
private List ccAddresses = DefaultSdkAutoConstructList.getInstance();
private List bccAddresses = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Destination model) {
toAddresses(model.toAddresses);
ccAddresses(model.ccAddresses);
bccAddresses(model.bccAddresses);
}
public final Collection getToAddresses() {
if (toAddresses instanceof SdkAutoConstructList) {
return null;
}
return toAddresses;
}
public final void setToAddresses(Collection toAddresses) {
this.toAddresses = AddressListCopier.copy(toAddresses);
}
@Override
public final Builder toAddresses(Collection toAddresses) {
this.toAddresses = AddressListCopier.copy(toAddresses);
return this;
}
@Override
@SafeVarargs
public final Builder toAddresses(String... toAddresses) {
toAddresses(Arrays.asList(toAddresses));
return this;
}
public final Collection getCcAddresses() {
if (ccAddresses instanceof SdkAutoConstructList) {
return null;
}
return ccAddresses;
}
public final void setCcAddresses(Collection ccAddresses) {
this.ccAddresses = AddressListCopier.copy(ccAddresses);
}
@Override
public final Builder ccAddresses(Collection ccAddresses) {
this.ccAddresses = AddressListCopier.copy(ccAddresses);
return this;
}
@Override
@SafeVarargs
public final Builder ccAddresses(String... ccAddresses) {
ccAddresses(Arrays.asList(ccAddresses));
return this;
}
public final Collection getBccAddresses() {
if (bccAddresses instanceof SdkAutoConstructList) {
return null;
}
return bccAddresses;
}
public final void setBccAddresses(Collection bccAddresses) {
this.bccAddresses = AddressListCopier.copy(bccAddresses);
}
@Override
public final Builder bccAddresses(Collection bccAddresses) {
this.bccAddresses = AddressListCopier.copy(bccAddresses);
return this;
}
@Override
@SafeVarargs
public final Builder bccAddresses(String... bccAddresses) {
bccAddresses(Arrays.asList(bccAddresses));
return this;
}
@Override
public Destination build() {
return new Destination(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy