software.amazon.awssdk.services.ses.model.TrackingOptions 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.io.Serializable;
import java.util.Arrays;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and
 * click events generated by Amazon SES emails.
 * 
 * 
 * For more information, see Configuring Custom Domains
 * to Handle Open and Click Tracking in the Amazon SES Developer Guide.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class TrackingOptions implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField CUSTOM_REDIRECT_DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("CustomRedirectDomain").getter(getter(TrackingOptions::customRedirectDomain))
            .setter(setter(Builder::customRedirectDomain))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomRedirectDomain").build())
            .build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CUSTOM_REDIRECT_DOMAIN_FIELD));

    private static final long serialVersionUID = 1L;

    private final String customRedirectDomain;

    private TrackingOptions(BuilderImpl builder) {
        this.customRedirectDomain = builder.customRedirectDomain;
    }

    /**
     * 
     * The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
     * 
     * 
     * @return The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
     */
    public final String customRedirectDomain() {
        return customRedirectDomain;
    }

    @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(customRedirectDomain());
        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 TrackingOptions)) {
            return false;
        }
        TrackingOptions other = (TrackingOptions) obj;
        return Objects.equals(customRedirectDomain(), other.customRedirectDomain());
    }

    /**
     * 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("TrackingOptions").add("CustomRedirectDomain", customRedirectDomain()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "CustomRedirectDomain":
            return Optional.ofNullable(clazz.cast(customRedirectDomain()));
        default:
            return Optional.empty();
        }
    }

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

    private static  Function getter(Function g) {
        return obj -> g.apply((TrackingOptions) obj);
    }

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
         * 
         * 
         * @param customRedirectDomain
         *        The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking
         *        domain.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder customRedirectDomain(String customRedirectDomain);
    }

    static final class BuilderImpl implements Builder {
        private String customRedirectDomain;

        private BuilderImpl() {
        }

        private BuilderImpl(TrackingOptions model) {
            customRedirectDomain(model.customRedirectDomain);
        }

        public final String getCustomRedirectDomain() {
            return customRedirectDomain;
        }

        public final void setCustomRedirectDomain(String customRedirectDomain) {
            this.customRedirectDomain = customRedirectDomain;
        }

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

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

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