/*
 * 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.sns.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * <p>
 * Input for ConfirmSubscription action.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ConfirmSubscription" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ConfirmSubscriptionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * <p>
     * The ARN of the topic for which you wish to confirm a subscription.
     * </p>
     */
    private String topicArn;
    /**
     * <p>
     * Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     * </p>
     */
    private String token;
    /**
     * <p>
     * Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code>
     * and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can
     * unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.
     * </p>
     */
    private String authenticateOnUnsubscribe;

    /**
     * Default constructor for ConfirmSubscriptionRequest object. Callers should use the setter or fluent setter
     * (with...) methods to initialize the object after creating it.
     */
    public ConfirmSubscriptionRequest() {
    }

    /**
     * Constructs a new ConfirmSubscriptionRequest object. Callers should use the setter or fluent setter (with...)
     * methods to initialize any additional object members.
     * 
     * @param topicArn
     *        The ARN of the topic for which you wish to confirm a subscription.
     * @param token
     *        Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     */
    public ConfirmSubscriptionRequest(String topicArn, String token) {
        setTopicArn(topicArn);
        setToken(token);
    }

    /**
     * Constructs a new ConfirmSubscriptionRequest object. Callers should use the setter or fluent setter (with...)
     * methods to initialize any additional object members.
     * 
     * @param topicArn
     *        The ARN of the topic for which you wish to confirm a subscription.
     * @param token
     *        Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     * @param authenticateOnUnsubscribe
     *        Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is
     *        <code>true</code> and the request has an Amazon Web Services signature, then only the topic owner and the
     *        subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services
     *        authentication.
     */
    public ConfirmSubscriptionRequest(String topicArn, String token, String authenticateOnUnsubscribe) {
        setTopicArn(topicArn);
        setToken(token);
        setAuthenticateOnUnsubscribe(authenticateOnUnsubscribe);
    }

    /**
     * <p>
     * The ARN of the topic for which you wish to confirm a subscription.
     * </p>
     * 
     * @param topicArn
     *        The ARN of the topic for which you wish to confirm a subscription.
     */

    public void setTopicArn(String topicArn) {
        this.topicArn = topicArn;
    }

    /**
     * <p>
     * The ARN of the topic for which you wish to confirm a subscription.
     * </p>
     * 
     * @return The ARN of the topic for which you wish to confirm a subscription.
     */

    public String getTopicArn() {
        return this.topicArn;
    }

    /**
     * <p>
     * The ARN of the topic for which you wish to confirm a subscription.
     * </p>
     * 
     * @param topicArn
     *        The ARN of the topic for which you wish to confirm a subscription.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ConfirmSubscriptionRequest withTopicArn(String topicArn) {
        setTopicArn(topicArn);
        return this;
    }

    /**
     * <p>
     * Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     * </p>
     * 
     * @param token
     *        Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     */

    public void setToken(String token) {
        this.token = token;
    }

    /**
     * <p>
     * Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     * </p>
     * 
     * @return Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     */

    public String getToken() {
        return this.token;
    }

    /**
     * <p>
     * Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     * </p>
     * 
     * @param token
     *        Short-lived token sent to an endpoint during the <code>Subscribe</code> action.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ConfirmSubscriptionRequest withToken(String token) {
        setToken(token);
        return this;
    }

    /**
     * <p>
     * Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code>
     * and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can
     * unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.
     * </p>
     * 
     * @param authenticateOnUnsubscribe
     *        Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is
     *        <code>true</code> and the request has an Amazon Web Services signature, then only the topic owner and the
     *        subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services
     *        authentication.
     */

    public void setAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe) {
        this.authenticateOnUnsubscribe = authenticateOnUnsubscribe;
    }

    /**
     * <p>
     * Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code>
     * and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can
     * unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.
     * </p>
     * 
     * @return Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is
     *         <code>true</code> and the request has an Amazon Web Services signature, then only the topic owner and the
     *         subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services
     *         authentication.
     */

    public String getAuthenticateOnUnsubscribe() {
        return this.authenticateOnUnsubscribe;
    }

    /**
     * <p>
     * Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is <code>true</code>
     * and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can
     * unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.
     * </p>
     * 
     * @param authenticateOnUnsubscribe
     *        Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is
     *        <code>true</code> and the request has an Amazon Web Services signature, then only the topic owner and the
     *        subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services
     *        authentication.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ConfirmSubscriptionRequest withAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe) {
        setAuthenticateOnUnsubscribe(authenticateOnUnsubscribe);
        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 (getTopicArn() != null)
            sb.append("TopicArn: ").append(getTopicArn()).append(",");
        if (getToken() != null)
            sb.append("Token: ").append(getToken()).append(",");
        if (getAuthenticateOnUnsubscribe() != null)
            sb.append("AuthenticateOnUnsubscribe: ").append(getAuthenticateOnUnsubscribe());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof ConfirmSubscriptionRequest == false)
            return false;
        ConfirmSubscriptionRequest other = (ConfirmSubscriptionRequest) obj;
        if (other.getTopicArn() == null ^ this.getTopicArn() == null)
            return false;
        if (other.getTopicArn() != null && other.getTopicArn().equals(this.getTopicArn()) == false)
            return false;
        if (other.getToken() == null ^ this.getToken() == null)
            return false;
        if (other.getToken() != null && other.getToken().equals(this.getToken()) == false)
            return false;
        if (other.getAuthenticateOnUnsubscribe() == null ^ this.getAuthenticateOnUnsubscribe() == null)
            return false;
        if (other.getAuthenticateOnUnsubscribe() != null && other.getAuthenticateOnUnsubscribe().equals(this.getAuthenticateOnUnsubscribe()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getTopicArn() == null) ? 0 : getTopicArn().hashCode());
        hashCode = prime * hashCode + ((getToken() == null) ? 0 : getToken().hashCode());
        hashCode = prime * hashCode + ((getAuthenticateOnUnsubscribe() == null) ? 0 : getAuthenticateOnUnsubscribe().hashCode());
        return hashCode;
    }

    @Override
    public ConfirmSubscriptionRequest clone() {
        return (ConfirmSubscriptionRequest) super.clone();
    }

}