com.amazonaws.services.pinpointemail.model.TrackingOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-pinpointemail Show documentation
The AWS Java SDK for Amazon Pinpoint Email module holds the client classes that are used for communicating with Amazon Pinpoint Email Service
There is a newer version: 1.12.778
Show newest version
/*
 * Copyright 2018-2023 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 com.amazonaws.services.pinpointemail.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email,
 * it contains an invisible image that's used to track when recipients open your email. If your email contains links,
 * those links are changed slightly in order to track when recipients click them.
 * 
 * 
 * These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint
 * to use a domain that you operate for these images and links.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TrackingOptions implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The domain that you want to use for tracking open and click events.
     * 
     */
    private String customRedirectDomain;

    /**
     * 
     * The domain that you want to use for tracking open and click events.
     * 
     * 
     * @param customRedirectDomain
     *        The domain that you want to use for tracking open and click events.
     */

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

    /**
     * 
     * The domain that you want to use for tracking open and click events.
     * 
     * 
     * @return The domain that you want to use for tracking open and click events.
     */

    public String getCustomRedirectDomain() {
        return this.customRedirectDomain;
    }

    /**
     * 
     * The domain that you want to use for tracking open and click events.
     * 
     * 
     * @param customRedirectDomain
     *        The domain that you want to use for tracking open and click events.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public TrackingOptions withCustomRedirectDomain(String customRedirectDomain) {
        setCustomRedirectDomain(customRedirectDomain);
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getCustomRedirectDomain() != null)
            sb.append("CustomRedirectDomain: ").append(getCustomRedirectDomain());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof TrackingOptions == false)
            return false;
        TrackingOptions other = (TrackingOptions) obj;
        if (other.getCustomRedirectDomain() == null ^ this.getCustomRedirectDomain() == null)
            return false;
        if (other.getCustomRedirectDomain() != null && other.getCustomRedirectDomain().equals(this.getCustomRedirectDomain()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getCustomRedirectDomain() == null) ? 0 : getCustomRedirectDomain().hashCode());
        return hashCode;
    }

    @Override
    public TrackingOptions clone() {
        try {
            return (TrackingOptions) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.pinpointemail.model.transform.TrackingOptionsMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}