com.amazonaws.services.simpleemail.model.SetIdentityFeedbackForwardingEnabledRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk Show documentation
The Amazon Web Services SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).
The newest version!
/*
 * Copyright 2010-2014 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.simpleemail.model;

import java.io.Serializable;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * Container for the parameters to the {@link com.amazonaws.services.simpleemail.AmazonSimpleEmailService#setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest) SetIdentityFeedbackForwardingEnabled operation}.
 * 
 * Given an identity (email address or domain), enables or disables
 * whether Amazon SES forwards feedback notifications as email. Feedback
 * forwarding may only be disabled when both complaint and bounce topics
 * are set.
 * 
 * 
 * This action is throttled at one request per second.
 * 
 * 
 * For more information about feedback notification, see the
 *  Amazon SES Developer Guide 
 * .
 * 
 *
 * @see com.amazonaws.services.simpleemail.AmazonSimpleEmailService#setIdentityFeedbackForwardingEnabled(SetIdentityFeedbackForwardingEnabledRequest)
 */
public class SetIdentityFeedbackForwardingEnabledRequest extends AmazonWebServiceRequest implements Serializable {

    /**
     * The identity for which to set feedback notification forwarding.
     * Examples: [email protected], example.com.
     */
    private String identity;

    /**
     * Sets whether Amazon SES will forward feedback notifications as email.
     * true specifies that Amazon SES will forward feedback
     * notifications as email, in addition to any Amazon SNS topic publishing
     * otherwise specified. false specifies that Amazon SES will
     * publish feedback notifications only through Amazon SNS. This value can
     * only be set to false when topics are specified for both
     * Bounce and Complaint topic types.
     */
    private Boolean forwardingEnabled;

    /**
     * The identity for which to set feedback notification forwarding.
     * Examples: [email protected], example.com.
     *
     * @return The identity for which to set feedback notification forwarding.
     *         Examples: [email protected], example.com.
     */
    public String getIdentity() {
        return identity;
    }
    
    /**
     * The identity for which to set feedback notification forwarding.
     * Examples: [email protected], example.com.
     *
     * @param identity The identity for which to set feedback notification forwarding.
     *         Examples: [email protected], example.com.
     */
    public void setIdentity(String identity) {
        this.identity = identity;
    }
    
    /**
     * The identity for which to set feedback notification forwarding.
     * Examples: [email protected], example.com.
     * 
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param identity The identity for which to set feedback notification forwarding.
     *         Examples: [email protected], example.com.
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together.
     */
    public SetIdentityFeedbackForwardingEnabledRequest withIdentity(String identity) {
        this.identity = identity;
        return this;
    }

    /**
     * Sets whether Amazon SES will forward feedback notifications as email.
     * true specifies that Amazon SES will forward feedback
     * notifications as email, in addition to any Amazon SNS topic publishing
     * otherwise specified. false specifies that Amazon SES will
     * publish feedback notifications only through Amazon SNS. This value can
     * only be set to false when topics are specified for both
     * Bounce and Complaint topic types.
     *
     * @return Sets whether Amazon SES will forward feedback notifications as email.
     *         true specifies that Amazon SES will forward feedback
     *         notifications as email, in addition to any Amazon SNS topic publishing
     *         otherwise specified. false specifies that Amazon SES will
     *         publish feedback notifications only through Amazon SNS. This value can
     *         only be set to false when topics are specified for both
     *         Bounce and Complaint topic types.
     */
    public Boolean isForwardingEnabled() {
        return forwardingEnabled;
    }
    
    /**
     * Sets whether Amazon SES will forward feedback notifications as email.
     * true specifies that Amazon SES will forward feedback
     * notifications as email, in addition to any Amazon SNS topic publishing
     * otherwise specified. false specifies that Amazon SES will
     * publish feedback notifications only through Amazon SNS. This value can
     * only be set to false when topics are specified for both
     * Bounce and Complaint topic types.
     *
     * @param forwardingEnabled Sets whether Amazon SES will forward feedback notifications as email.
     *         true specifies that Amazon SES will forward feedback
     *         notifications as email, in addition to any Amazon SNS topic publishing
     *         otherwise specified. false specifies that Amazon SES will
     *         publish feedback notifications only through Amazon SNS. This value can
     *         only be set to false when topics are specified for both
     *         Bounce and Complaint topic types.
     */
    public void setForwardingEnabled(Boolean forwardingEnabled) {
        this.forwardingEnabled = forwardingEnabled;
    }
    
    /**
     * Sets whether Amazon SES will forward feedback notifications as email.
     * true specifies that Amazon SES will forward feedback
     * notifications as email, in addition to any Amazon SNS topic publishing
     * otherwise specified. false specifies that Amazon SES will
     * publish feedback notifications only through Amazon SNS. This value can
     * only be set to false when topics are specified for both
     * Bounce and Complaint topic types.
     * 
     * Returns a reference to this object so that method calls can be chained together.
     *
     * @param forwardingEnabled Sets whether Amazon SES will forward feedback notifications as email.
     *         true specifies that Amazon SES will forward feedback
     *         notifications as email, in addition to any Amazon SNS topic publishing
     *         otherwise specified. false specifies that Amazon SES will
     *         publish feedback notifications only through Amazon SNS. This value can
     *         only be set to false when topics are specified for both
     *         Bounce and Complaint topic types.
     *
     * @return A reference to this updated object so that method calls can be chained 
     *         together.
     */
    public SetIdentityFeedbackForwardingEnabledRequest withForwardingEnabled(Boolean forwardingEnabled) {
        this.forwardingEnabled = forwardingEnabled;
        return this;
    }

    /**
     * Sets whether Amazon SES will forward feedback notifications as email.
     * true specifies that Amazon SES will forward feedback
     * notifications as email, in addition to any Amazon SNS topic publishing
     * otherwise specified. false specifies that Amazon SES will
     * publish feedback notifications only through Amazon SNS. This value can
     * only be set to false when topics are specified for both
     * Bounce and Complaint topic types.
     *
     * @return Sets whether Amazon SES will forward feedback notifications as email.
     *         true specifies that Amazon SES will forward feedback
     *         notifications as email, in addition to any Amazon SNS topic publishing
     *         otherwise specified. false specifies that Amazon SES will
     *         publish feedback notifications only through Amazon SNS. This value can
     *         only be set to false when topics are specified for both
     *         Bounce and Complaint topic types.
     */
    public Boolean getForwardingEnabled() {
        return forwardingEnabled;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getIdentity() != null) sb.append("Identity: " + getIdentity() + ",");
        if (isForwardingEnabled() != null) sb.append("ForwardingEnabled: " + isForwardingEnabled() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getIdentity() == null) ? 0 : getIdentity().hashCode()); 
        hashCode = prime * hashCode + ((isForwardingEnabled() == null) ? 0 : isForwardingEnabled().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null) return false;

        if (obj instanceof SetIdentityFeedbackForwardingEnabledRequest == false) return false;
        SetIdentityFeedbackForwardingEnabledRequest other = (SetIdentityFeedbackForwardingEnabledRequest)obj;
        
        if (other.getIdentity() == null ^ this.getIdentity() == null) return false;
        if (other.getIdentity() != null && other.getIdentity().equals(this.getIdentity()) == false) return false; 
        if (other.isForwardingEnabled() == null ^ this.isForwardingEnabled() == null) return false;
        if (other.isForwardingEnabled() != null && other.isForwardingEnabled().equals(this.isForwardingEnabled()) == false) return false; 
        return true;
    }
    
}