software.amazon.awssdk.services.ses.model.SendCustomVerificationEmailRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
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
There is a newer version: 2.29.39
Show newest version
/*
 * 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.util.Arrays;
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 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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * Represents a request to send a custom verification email to a specified recipient.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class SendCustomVerificationEmailRequest extends SesRequest implements
        ToCopyableBuilder {
    private static final SdkField EMAIL_ADDRESS_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("EmailAddress").getter(getter(SendCustomVerificationEmailRequest::emailAddress))
            .setter(setter(Builder::emailAddress))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EmailAddress").build()).build();

    private static final SdkField TEMPLATE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("TemplateName").getter(getter(SendCustomVerificationEmailRequest::templateName))
            .setter(setter(Builder::templateName))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateName").build()).build();

    private static final SdkField CONFIGURATION_SET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("ConfigurationSetName").getter(getter(SendCustomVerificationEmailRequest::configurationSetName))
            .setter(setter(Builder::configurationSetName))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConfigurationSetName").build())
            .build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(EMAIL_ADDRESS_FIELD,
            TEMPLATE_NAME_FIELD, CONFIGURATION_SET_NAME_FIELD));

    private static final Map> SDK_NAME_TO_FIELD = Collections
            .unmodifiableMap(new HashMap>() {
                {
                    put("EmailAddress", EMAIL_ADDRESS_FIELD);
                    put("TemplateName", TEMPLATE_NAME_FIELD);
                    put("ConfigurationSetName", CONFIGURATION_SET_NAME_FIELD);
                }
            });

    private final String emailAddress;

    private final String templateName;

    private final String configurationSetName;

    private SendCustomVerificationEmailRequest(BuilderImpl builder) {
        super(builder);
        this.emailAddress = builder.emailAddress;
        this.templateName = builder.templateName;
        this.configurationSetName = builder.configurationSetName;
    }

    /**
     * 
     * The email address to verify.
     * 
     * 
     * @return The email address to verify.
     */
    public final String emailAddress() {
        return emailAddress;
    }

    /**
     * 
     * The name of the custom verification email template to use when sending the verification email.
     * 
     * 
     * @return The name of the custom verification email template to use when sending the verification email.
     */
    public final String templateName() {
        return templateName;
    }

    /**
     * 
     * Name of a configuration set to use when sending the verification email.
     * 
     * 
     * @return Name of a configuration set to use when sending the verification email.
     */
    public final String configurationSetName() {
        return configurationSetName;
    }

    @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(emailAddress());
        hashCode = 31 * hashCode + Objects.hashCode(templateName());
        hashCode = 31 * hashCode + Objects.hashCode(configurationSetName());
        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 SendCustomVerificationEmailRequest)) {
            return false;
        }
        SendCustomVerificationEmailRequest other = (SendCustomVerificationEmailRequest) obj;
        return Objects.equals(emailAddress(), other.emailAddress()) && Objects.equals(templateName(), other.templateName())
                && Objects.equals(configurationSetName(), other.configurationSetName());
    }

    /**
     * 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("SendCustomVerificationEmailRequest").add("EmailAddress", emailAddress())
                .add("TemplateName", templateName()).add("ConfigurationSetName", configurationSetName()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "EmailAddress":
            return Optional.ofNullable(clazz.cast(emailAddress()));
        case "TemplateName":
            return Optional.ofNullable(clazz.cast(templateName()));
        case "ConfigurationSetName":
            return Optional.ofNullable(clazz.cast(configurationSetName()));
        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((SendCustomVerificationEmailRequest) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SesRequest.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * The email address to verify.
         * 
         * 
         * @param emailAddress
         *        The email address to verify.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder emailAddress(String emailAddress);

        /**
         * 
         * The name of the custom verification email template to use when sending the verification email.
         * 
         * 
         * @param templateName
         *        The name of the custom verification email template to use when sending the verification email.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder templateName(String templateName);

        /**
         * 
         * Name of a configuration set to use when sending the verification email.
         * 
         * 
         * @param configurationSetName
         *        Name of a configuration set to use when sending the verification email.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder configurationSetName(String configurationSetName);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends SesRequest.BuilderImpl implements Builder {
        private String emailAddress;

        private String templateName;

        private String configurationSetName;

        private BuilderImpl() {
        }

        private BuilderImpl(SendCustomVerificationEmailRequest model) {
            super(model);
            emailAddress(model.emailAddress);
            templateName(model.templateName);
            configurationSetName(model.configurationSetName);
        }

        public final String getEmailAddress() {
            return emailAddress;
        }

        public final void setEmailAddress(String emailAddress) {
            this.emailAddress = emailAddress;
        }

        @Override
        public final Builder emailAddress(String emailAddress) {
            this.emailAddress = emailAddress;
            return this;
        }

        public final String getTemplateName() {
            return templateName;
        }

        public final void setTemplateName(String templateName) {
            this.templateName = templateName;
        }

        @Override
        public final Builder templateName(String templateName) {
            this.templateName = templateName;
            return this;
        }

        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;
        }

        @Override
        public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
            super.overrideConfiguration(overrideConfiguration);
            return this;
        }

        @Override
        public Builder overrideConfiguration(Consumer builderConsumer) {
            super.overrideConfiguration(builderConsumer);
            return this;
        }

        @Override
        public SendCustomVerificationEmailRequest build() {
            return new SendCustomVerificationEmailRequest(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }

        @Override
        public Map> sdkFieldNameToField() {
            return SDK_NAME_TO_FIELD;
        }
    }
}