software.amazon.awssdk.services.ses.model.BulkEmailDestination 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.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*
* An array that contains one or more Destinations, as well as the tags and replacement data associated with each of
* those Destinations.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class BulkEmailDestination implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DESTINATION_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Destination").getter(getter(BulkEmailDestination::destination)).setter(setter(Builder::destination))
.constructor(Destination::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Destination").build()).build();
private static final SdkField> REPLACEMENT_TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ReplacementTags")
.getter(getter(BulkEmailDestination::replacementTags))
.setter(setter(Builder::replacementTags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplacementTags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MessageTag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField REPLACEMENT_TEMPLATE_DATA_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReplacementTemplateData").getter(getter(BulkEmailDestination::replacementTemplateData))
.setter(setter(Builder::replacementTemplateData))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplacementTemplateData").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESTINATION_FIELD,
REPLACEMENT_TAGS_FIELD, REPLACEMENT_TEMPLATE_DATA_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Destination", DESTINATION_FIELD);
put("ReplacementTags", REPLACEMENT_TAGS_FIELD);
put("ReplacementTemplateData", REPLACEMENT_TEMPLATE_DATA_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final Destination destination;
private final List replacementTags;
private final String replacementTemplateData;
private BulkEmailDestination(BuilderImpl builder) {
this.destination = builder.destination;
this.replacementTags = builder.replacementTags;
this.replacementTemplateData = builder.replacementTemplateData;
}
/**
* Returns the value of the Destination property for this object.
*
* @return The value of the Destination property for this object.
*/
public final Destination destination() {
return destination;
}
/**
* For responses, this returns true if the service returned a value for the ReplacementTags 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 hasReplacementTags() {
return replacementTags != null && !(replacementTags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags, in the form of name/value pairs, to apply to an email that you send using
* SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you
* can publish email sending events.
*
*
* 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 #hasReplacementTags} method.
*
*
* @return A list of tags, in the form of name/value pairs, to apply to an email that you send using
* SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so
* that you can publish email sending events.
*/
public final List replacementTags() {
return replacementTags;
}
/**
*
* A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of
* key-value pairs in which the keys correspond to replacement tags in the email template.
*
*
* @return A list of replacement values to apply to the template. This parameter is a JSON object, typically
* consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
*/
public final String replacementTemplateData() {
return replacementTemplateData;
}
@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(destination());
hashCode = 31 * hashCode + Objects.hashCode(hasReplacementTags() ? replacementTags() : null);
hashCode = 31 * hashCode + Objects.hashCode(replacementTemplateData());
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 BulkEmailDestination)) {
return false;
}
BulkEmailDestination other = (BulkEmailDestination) obj;
return Objects.equals(destination(), other.destination()) && hasReplacementTags() == other.hasReplacementTags()
&& Objects.equals(replacementTags(), other.replacementTags())
&& Objects.equals(replacementTemplateData(), other.replacementTemplateData());
}
/**
* 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("BulkEmailDestination").add("Destination", destination())
.add("ReplacementTags", hasReplacementTags() ? replacementTags() : null)
.add("ReplacementTemplateData", replacementTemplateData()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Destination":
return Optional.ofNullable(clazz.cast(destination()));
case "ReplacementTags":
return Optional.ofNullable(clazz.cast(replacementTags()));
case "ReplacementTemplateData":
return Optional.ofNullable(clazz.cast(replacementTemplateData()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((BulkEmailDestination) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* Sets the value of the Destination property for this object.
*
* @param destination
* The new value for the Destination property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder destination(Destination destination);
/**
* Sets the value of the Destination property for this object.
*
* This is a convenience method that creates an instance of the {@link Destination.Builder} avoiding the need to
* create one manually via {@link Destination#builder()}.
*
*
* When the {@link Consumer} completes, {@link Destination.Builder#build()} is called immediately and its result
* is passed to {@link #destination(Destination)}.
*
* @param destination
* a consumer that will call methods on {@link Destination.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #destination(Destination)
*/
default Builder destination(Consumer destination) {
return destination(Destination.builder().applyMutation(destination).build());
}
/**
*
* A list of tags, in the form of name/value pairs, to apply to an email that you send using
* SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that
* you can publish email sending events.
*
*
* @param replacementTags
* A list of tags, in the form of name/value pairs, to apply to an email that you send using
* SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define,
* so that you can publish email sending events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replacementTags(Collection replacementTags);
/**
*
* A list of tags, in the form of name/value pairs, to apply to an email that you send using
* SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that
* you can publish email sending events.
*
*
* @param replacementTags
* A list of tags, in the form of name/value pairs, to apply to an email that you send using
* SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define,
* so that you can publish email sending events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replacementTags(MessageTag... replacementTags);
/**
*
* A list of tags, in the form of name/value pairs, to apply to an email that you send using
* SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that
* you can publish email sending events.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ses.model.MessageTag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.ses.model.MessageTag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ses.model.MessageTag.Builder#build()} is called immediately and its
* result is passed to {@link #replacementTags(List)}.
*
* @param replacementTags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ses.model.MessageTag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #replacementTags(java.util.Collection)
*/
Builder replacementTags(Consumer... replacementTags);
/**
*
* A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting
* of key-value pairs in which the keys correspond to replacement tags in the email template.
*
*
* @param replacementTemplateData
* A list of replacement values to apply to the template. This parameter is a JSON object, typically
* consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replacementTemplateData(String replacementTemplateData);
}
static final class BuilderImpl implements Builder {
private Destination destination;
private List replacementTags = DefaultSdkAutoConstructList.getInstance();
private String replacementTemplateData;
private BuilderImpl() {
}
private BuilderImpl(BulkEmailDestination model) {
destination(model.destination);
replacementTags(model.replacementTags);
replacementTemplateData(model.replacementTemplateData);
}
public final Destination.Builder getDestination() {
return destination != null ? destination.toBuilder() : null;
}
public final void setDestination(Destination.BuilderImpl destination) {
this.destination = destination != null ? destination.build() : null;
}
@Override
public final Builder destination(Destination destination) {
this.destination = destination;
return this;
}
public final List getReplacementTags() {
List result = MessageTagListCopier.copyToBuilder(this.replacementTags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setReplacementTags(Collection replacementTags) {
this.replacementTags = MessageTagListCopier.copyFromBuilder(replacementTags);
}
@Override
public final Builder replacementTags(Collection replacementTags) {
this.replacementTags = MessageTagListCopier.copy(replacementTags);
return this;
}
@Override
@SafeVarargs
public final Builder replacementTags(MessageTag... replacementTags) {
replacementTags(Arrays.asList(replacementTags));
return this;
}
@Override
@SafeVarargs
public final Builder replacementTags(Consumer... replacementTags) {
replacementTags(Stream.of(replacementTags).map(c -> MessageTag.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getReplacementTemplateData() {
return replacementTemplateData;
}
public final void setReplacementTemplateData(String replacementTemplateData) {
this.replacementTemplateData = replacementTemplateData;
}
@Override
public final Builder replacementTemplateData(String replacementTemplateData) {
this.replacementTemplateData = replacementTemplateData;
return this;
}
@Override
public BulkEmailDestination build() {
return new BulkEmailDestination(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}