com.amazonaws.services.sns.model.SubscribeResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-sns Show documentation
The AWS Java SDK for Amazon SNS module holds the client classes that are used for communicating with Amazon Simple Notification Service
There is a newer version: 1.12.772
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.sns.model;

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

/**
 * 
 * Response for Subscribe action.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SubscribeResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {

    /**
     * 
     * The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires
     * confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is
     * always the subscription ARN, even if the subscription requires confirmation.
     * 
     */
    private String subscriptionArn;

    /**
     * 
     * The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires
     * confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is
     * always the subscription ARN, even if the subscription requires confirmation.
     * 
     * 
     * @param subscriptionArn
     *        The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription
     *        requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true,
     *        then the value is always the subscription ARN, even if the subscription requires confirmation.
     */

    public void setSubscriptionArn(String subscriptionArn) {
        this.subscriptionArn = subscriptionArn;
    }

    /**
     * 
     * The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires
     * confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is
     * always the subscription ARN, even if the subscription requires confirmation.
     * 
     * 
     * @return The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription
     *         requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true,
     *         then the value is always the subscription ARN, even if the subscription requires confirmation.
     */

    public String getSubscriptionArn() {
        return this.subscriptionArn;
    }

    /**
     * 
     * The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires
     * confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is
     * always the subscription ARN, even if the subscription requires confirmation.
     * 
     * 
     * @param subscriptionArn
     *        The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription
     *        requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true,
     *        then the value is always the subscription ARN, even if the subscription requires confirmation.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SubscribeResult withSubscriptionArn(String subscriptionArn) {
        setSubscriptionArn(subscriptionArn);
        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 (getSubscriptionArn() != null)
            sb.append("SubscriptionArn: ").append(getSubscriptionArn());
        sb.append("}");
        return sb.toString();
    }

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

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

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

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

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

}