software.amazon.awssdk.services.pinpointemail.model.CreateConfigurationSetRequest 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 create a configuration set.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateConfigurationSetRequest extends PinpointEmailRequest implements
ToCopyableBuilder {
private static final SdkField CONFIGURATION_SET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConfigurationSetName").getter(getter(CreateConfigurationSetRequest::configurationSetName))
.setter(setter(Builder::configurationSetName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConfigurationSetName").build())
.build();
private static final SdkField TRACKING_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TrackingOptions")
.getter(getter(CreateConfigurationSetRequest::trackingOptions)).setter(setter(Builder::trackingOptions))
.constructor(TrackingOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TrackingOptions").build()).build();
private static final SdkField DELIVERY_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DeliveryOptions")
.getter(getter(CreateConfigurationSetRequest::deliveryOptions)).setter(setter(Builder::deliveryOptions))
.constructor(DeliveryOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeliveryOptions").build()).build();
private static final SdkField REPUTATION_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ReputationOptions")
.getter(getter(CreateConfigurationSetRequest::reputationOptions)).setter(setter(Builder::reputationOptions))
.constructor(ReputationOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReputationOptions").build()).build();
private static final SdkField SENDING_OPTIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SendingOptions")
.getter(getter(CreateConfigurationSetRequest::sendingOptions)).setter(setter(Builder::sendingOptions))
.constructor(SendingOptions::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SendingOptions").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateConfigurationSetRequest::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(CONFIGURATION_SET_NAME_FIELD,
TRACKING_OPTIONS_FIELD, DELIVERY_OPTIONS_FIELD, REPUTATION_OPTIONS_FIELD, SENDING_OPTIONS_FIELD, TAGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("ConfigurationSetName", CONFIGURATION_SET_NAME_FIELD);
put("TrackingOptions", TRACKING_OPTIONS_FIELD);
put("DeliveryOptions", DELIVERY_OPTIONS_FIELD);
put("ReputationOptions", REPUTATION_OPTIONS_FIELD);
put("SendingOptions", SENDING_OPTIONS_FIELD);
put("Tags", TAGS_FIELD);
}
});
private final String configurationSetName;
private final TrackingOptions trackingOptions;
private final DeliveryOptions deliveryOptions;
private final ReputationOptions reputationOptions;
private final SendingOptions sendingOptions;
private final List tags;
private CreateConfigurationSetRequest(BuilderImpl builder) {
super(builder);
this.configurationSetName = builder.configurationSetName;
this.trackingOptions = builder.trackingOptions;
this.deliveryOptions = builder.deliveryOptions;
this.reputationOptions = builder.reputationOptions;
this.sendingOptions = builder.sendingOptions;
this.tags = builder.tags;
}
/**
*
* The name of the configuration set.
*
*
* @return The name of the configuration set.
*/
public final String configurationSetName() {
return configurationSetName;
}
/**
*
* An object that defines the open and click tracking options for emails that you send using the configuration set.
*
*
* @return An object that defines the open and click tracking options for emails that you send using the
* configuration set.
*/
public final TrackingOptions trackingOptions() {
return trackingOptions;
}
/**
*
* An object that defines the dedicated IP pool that is used to send emails that you send using the configuration
* set.
*
*
* @return An object that defines the dedicated IP pool that is used to send emails that you send using the
* configuration set.
*/
public final DeliveryOptions deliveryOptions() {
return deliveryOptions;
}
/**
*
* An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send
* that use the configuration set.
*
*
* @return An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you
* send that use the configuration set.
*/
public final ReputationOptions reputationOptions() {
return reputationOptions;
}
/**
*
* An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.
*
*
* @return An object that defines whether or not Amazon Pinpoint can send email that you send using the
* configuration set.
*/
public final SendingOptions sendingOptions() {
return sendingOptions;
}
/**
* 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 configuration set.
*
*
* 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
* configuration set.
*/
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(configurationSetName());
hashCode = 31 * hashCode + Objects.hashCode(trackingOptions());
hashCode = 31 * hashCode + Objects.hashCode(deliveryOptions());
hashCode = 31 * hashCode + Objects.hashCode(reputationOptions());
hashCode = 31 * hashCode + Objects.hashCode(sendingOptions());
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 CreateConfigurationSetRequest)) {
return false;
}
CreateConfigurationSetRequest other = (CreateConfigurationSetRequest) obj;
return Objects.equals(configurationSetName(), other.configurationSetName())
&& Objects.equals(trackingOptions(), other.trackingOptions())
&& Objects.equals(deliveryOptions(), other.deliveryOptions())
&& Objects.equals(reputationOptions(), other.reputationOptions())
&& Objects.equals(sendingOptions(), other.sendingOptions()) && 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("CreateConfigurationSetRequest").add("ConfigurationSetName", configurationSetName())
.add("TrackingOptions", trackingOptions()).add("DeliveryOptions", deliveryOptions())
.add("ReputationOptions", reputationOptions()).add("SendingOptions", sendingOptions())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ConfigurationSetName":
return Optional.ofNullable(clazz.cast(configurationSetName()));
case "TrackingOptions":
return Optional.ofNullable(clazz.cast(trackingOptions()));
case "DeliveryOptions":
return Optional.ofNullable(clazz.cast(deliveryOptions()));
case "ReputationOptions":
return Optional.ofNullable(clazz.cast(reputationOptions()));
case "SendingOptions":
return Optional.ofNullable(clazz.cast(sendingOptions()));
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((CreateConfigurationSetRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PinpointEmailRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The name of the configuration set.
*
*
* @param configurationSetName
* The name of the configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configurationSetName(String configurationSetName);
/**
*
* An object that defines the open and click tracking options for emails that you send using the configuration
* set.
*
*
* @param trackingOptions
* An object that defines the open and click tracking options for emails that you send using the
* configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trackingOptions(TrackingOptions trackingOptions);
/**
*
* An object that defines the open and click tracking options for emails that you send using the configuration
* set.
*
* This is a convenience method that creates an instance of the {@link TrackingOptions.Builder} avoiding the
* need to create one manually via {@link TrackingOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link TrackingOptions.Builder#build()} is called immediately and its
* result is passed to {@link #trackingOptions(TrackingOptions)}.
*
* @param trackingOptions
* a consumer that will call methods on {@link TrackingOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #trackingOptions(TrackingOptions)
*/
default Builder trackingOptions(Consumer trackingOptions) {
return trackingOptions(TrackingOptions.builder().applyMutation(trackingOptions).build());
}
/**
*
* An object that defines the dedicated IP pool that is used to send emails that you send using the
* configuration set.
*
*
* @param deliveryOptions
* An object that defines the dedicated IP pool that is used to send emails that you send using the
* configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deliveryOptions(DeliveryOptions deliveryOptions);
/**
*
* An object that defines the dedicated IP pool that is used to send emails that you send using the
* configuration set.
*
* This is a convenience method that creates an instance of the {@link DeliveryOptions.Builder} avoiding the
* need to create one manually via {@link DeliveryOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link DeliveryOptions.Builder#build()} is called immediately and its
* result is passed to {@link #deliveryOptions(DeliveryOptions)}.
*
* @param deliveryOptions
* a consumer that will call methods on {@link DeliveryOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #deliveryOptions(DeliveryOptions)
*/
default Builder deliveryOptions(Consumer deliveryOptions) {
return deliveryOptions(DeliveryOptions.builder().applyMutation(deliveryOptions).build());
}
/**
*
* An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you
* send that use the configuration set.
*
*
* @param reputationOptions
* An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that
* you send that use the configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reputationOptions(ReputationOptions reputationOptions);
/**
*
* An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you
* send that use the configuration set.
*
* This is a convenience method that creates an instance of the {@link ReputationOptions.Builder} avoiding the
* need to create one manually via {@link ReputationOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link ReputationOptions.Builder#build()} is called immediately and its
* result is passed to {@link #reputationOptions(ReputationOptions)}.
*
* @param reputationOptions
* a consumer that will call methods on {@link ReputationOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #reputationOptions(ReputationOptions)
*/
default Builder reputationOptions(Consumer reputationOptions) {
return reputationOptions(ReputationOptions.builder().applyMutation(reputationOptions).build());
}
/**
*
* An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration
* set.
*
*
* @param sendingOptions
* An object that defines whether or not Amazon Pinpoint can send email that you send using the
* configuration set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sendingOptions(SendingOptions sendingOptions);
/**
*
* An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration
* set.
*
* This is a convenience method that creates an instance of the {@link SendingOptions.Builder} avoiding the need
* to create one manually via {@link SendingOptions#builder()}.
*
*
* When the {@link Consumer} completes, {@link SendingOptions.Builder#build()} is called immediately and its
* result is passed to {@link #sendingOptions(SendingOptions)}.
*
* @param sendingOptions
* a consumer that will call methods on {@link SendingOptions.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #sendingOptions(SendingOptions)
*/
default Builder sendingOptions(Consumer sendingOptions) {
return sendingOptions(SendingOptions.builder().applyMutation(sendingOptions).build());
}
/**
*
* An array of objects that define the tags (keys and values) that you want to associate with the configuration
* set.
*
*
* @param tags
* An array of objects that define the tags (keys and values) that you want to associate with the
* configuration set.
* @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 configuration
* set.
*
*
* @param tags
* An array of objects that define the tags (keys and values) that you want to associate with the
* configuration set.
* @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 configuration
* set.
*
* 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 configurationSetName;
private TrackingOptions trackingOptions;
private DeliveryOptions deliveryOptions;
private ReputationOptions reputationOptions;
private SendingOptions sendingOptions;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateConfigurationSetRequest model) {
super(model);
configurationSetName(model.configurationSetName);
trackingOptions(model.trackingOptions);
deliveryOptions(model.deliveryOptions);
reputationOptions(model.reputationOptions);
sendingOptions(model.sendingOptions);
tags(model.tags);
}
public final String getConfigurationSetName() {
return configurationSetName;
}
public final void setConfigurationSetName(String configurationSetName) {
this.configurationSetName = configurationSetName;
}
@Override
public final Builder configurationSetName(String configurationSetName) {
this.configurationSetName = configurationSetName;
return this;
}
public final TrackingOptions.Builder getTrackingOptions() {
return trackingOptions != null ? trackingOptions.toBuilder() : null;
}
public final void setTrackingOptions(TrackingOptions.BuilderImpl trackingOptions) {
this.trackingOptions = trackingOptions != null ? trackingOptions.build() : null;
}
@Override
public final Builder trackingOptions(TrackingOptions trackingOptions) {
this.trackingOptions = trackingOptions;
return this;
}
public final DeliveryOptions.Builder getDeliveryOptions() {
return deliveryOptions != null ? deliveryOptions.toBuilder() : null;
}
public final void setDeliveryOptions(DeliveryOptions.BuilderImpl deliveryOptions) {
this.deliveryOptions = deliveryOptions != null ? deliveryOptions.build() : null;
}
@Override
public final Builder deliveryOptions(DeliveryOptions deliveryOptions) {
this.deliveryOptions = deliveryOptions;
return this;
}
public final ReputationOptions.Builder getReputationOptions() {
return reputationOptions != null ? reputationOptions.toBuilder() : null;
}
public final void setReputationOptions(ReputationOptions.BuilderImpl reputationOptions) {
this.reputationOptions = reputationOptions != null ? reputationOptions.build() : null;
}
@Override
public final Builder reputationOptions(ReputationOptions reputationOptions) {
this.reputationOptions = reputationOptions;
return this;
}
public final SendingOptions.Builder getSendingOptions() {
return sendingOptions != null ? sendingOptions.toBuilder() : null;
}
public final void setSendingOptions(SendingOptions.BuilderImpl sendingOptions) {
this.sendingOptions = sendingOptions != null ? sendingOptions.build() : null;
}
@Override
public final Builder sendingOptions(SendingOptions sendingOptions) {
this.sendingOptions = sendingOptions;
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 CreateConfigurationSetRequest build() {
return new CreateConfigurationSetRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}