software.amazon.awssdk.services.pinpointemail.model.CreateDeliverabilityTestReportRequest Maven / Gradle / Ivy
Show all versions of pinpointemail 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.pinpointemail.model;
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.awscore.AwsRequestOverrideConfiguration;
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 request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how
* your messages will be handled by various email providers around the world. When you perform a predictive inbox
* placement test, you provide a sample message that contains the content that you plan to send to your customers.
* Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After
* about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view
* the results of the test.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateDeliverabilityTestReportRequest extends PinpointEmailRequest implements
ToCopyableBuilder {
private static final SdkField REPORT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReportName").getter(getter(CreateDeliverabilityTestReportRequest::reportName))
.setter(setter(Builder::reportName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReportName").build()).build();
private static final SdkField FROM_EMAIL_ADDRESS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FromEmailAddress").getter(getter(CreateDeliverabilityTestReportRequest::fromEmailAddress))
.setter(setter(Builder::fromEmailAddress))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FromEmailAddress").build()).build();
private static final SdkField CONTENT_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Content").getter(getter(CreateDeliverabilityTestReportRequest::content))
.setter(setter(Builder::content)).constructor(EmailContent::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Content").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateDeliverabilityTestReportRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(REPORT_NAME_FIELD,
FROM_EMAIL_ADDRESS_FIELD, CONTENT_FIELD, TAGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("ReportName", REPORT_NAME_FIELD);
put("FromEmailAddress", FROM_EMAIL_ADDRESS_FIELD);
put("Content", CONTENT_FIELD);
put("Tags", TAGS_FIELD);
}
});
private final String reportName;
private final String fromEmailAddress;
private final EmailContent content;
private final List tags;
private CreateDeliverabilityTestReportRequest(BuilderImpl builder) {
super(builder);
this.reportName = builder.reportName;
this.fromEmailAddress = builder.fromEmailAddress;
this.content = builder.content;
this.tags = builder.tags;
}
/**
*
* A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
*
*
* @return A unique name that helps you to identify the predictive inbox placement test when you retrieve the
* results.
*/
public final String reportName() {
return reportName;
}
/**
*
* The email address that the predictive inbox placement test email was sent from.
*
*
* @return The email address that the predictive inbox placement test email was sent from.
*/
public final String fromEmailAddress() {
return fromEmailAddress;
}
/**
*
* The HTML body of the message that you sent when you performed the predictive inbox placement test.
*
*
* @return The HTML body of the message that you sent when you performed the predictive inbox placement test.
*/
public final EmailContent content() {
return content;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox
* placement test.
*
*
* 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 #hasTags} method.
*
*
* @return An array of objects that define the tags (keys and values) that you want to associate with the predictive
* inbox placement test.
*/
public final List tags() {
return tags;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(reportName());
hashCode = 31 * hashCode + Objects.hashCode(fromEmailAddress());
hashCode = 31 * hashCode + Objects.hashCode(content());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateDeliverabilityTestReportRequest)) {
return false;
}
CreateDeliverabilityTestReportRequest other = (CreateDeliverabilityTestReportRequest) obj;
return Objects.equals(reportName(), other.reportName()) && Objects.equals(fromEmailAddress(), other.fromEmailAddress())
&& Objects.equals(content(), other.content()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateDeliverabilityTestReportRequest").add("ReportName", reportName())
.add("FromEmailAddress", fromEmailAddress()).add("Content", content()).add("Tags", hasTags() ? tags() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReportName":
return Optional.ofNullable(clazz.cast(reportName()));
case "FromEmailAddress":
return Optional.ofNullable(clazz.cast(fromEmailAddress()));
case "Content":
return Optional.ofNullable(clazz.cast(content()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
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((CreateDeliverabilityTestReportRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PinpointEmailRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
*
*
* @param reportName
* A unique name that helps you to identify the predictive inbox placement test when you retrieve the
* results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reportName(String reportName);
/**
*
* The email address that the predictive inbox placement test email was sent from.
*
*
* @param fromEmailAddress
* The email address that the predictive inbox placement test email was sent from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fromEmailAddress(String fromEmailAddress);
/**
*
* The HTML body of the message that you sent when you performed the predictive inbox placement test.
*
*
* @param content
* The HTML body of the message that you sent when you performed the predictive inbox placement test.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder content(EmailContent content);
/**
*
* The HTML body of the message that you sent when you performed the predictive inbox placement test.
*
* This is a convenience method that creates an instance of the {@link EmailContent.Builder} avoiding the need
* to create one manually via {@link EmailContent#builder()}.
*
*
* When the {@link Consumer} completes, {@link EmailContent.Builder#build()} is called immediately and its
* result is passed to {@link #content(EmailContent)}.
*
* @param content
* a consumer that will call methods on {@link EmailContent.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #content(EmailContent)
*/
default Builder content(Consumer content) {
return content(EmailContent.builder().applyMutation(content).build());
}
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the predictive
* inbox placement test.
*
*
* @param tags
* An array of objects that define the tags (keys and values) that you want to associate with the
* predictive inbox placement test.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the predictive
* inbox placement test.
*
*
* @param tags
* An array of objects that define the tags (keys and values) that you want to associate with the
* predictive inbox placement test.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the predictive
* inbox placement test.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.pinpointemail.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.pinpointemail.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.pinpointemail.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.pinpointemail.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends PinpointEmailRequest.BuilderImpl implements Builder {
private String reportName;
private String fromEmailAddress;
private EmailContent content;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateDeliverabilityTestReportRequest model) {
super(model);
reportName(model.reportName);
fromEmailAddress(model.fromEmailAddress);
content(model.content);
tags(model.tags);
}
public final String getReportName() {
return reportName;
}
public final void setReportName(String reportName) {
this.reportName = reportName;
}
@Override
public final Builder reportName(String reportName) {
this.reportName = reportName;
return this;
}
public final String getFromEmailAddress() {
return fromEmailAddress;
}
public final void setFromEmailAddress(String fromEmailAddress) {
this.fromEmailAddress = fromEmailAddress;
}
@Override
public final Builder fromEmailAddress(String fromEmailAddress) {
this.fromEmailAddress = fromEmailAddress;
return this;
}
public final EmailContent.Builder getContent() {
return content != null ? content.toBuilder() : null;
}
public final void setContent(EmailContent.BuilderImpl content) {
this.content = content != null ? content.build() : null;
}
@Override
public final Builder content(EmailContent content) {
this.content = content;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateDeliverabilityTestReportRequest build() {
return new CreateDeliverabilityTestReportRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}