com.amazonaws.services.sns.model.UnsubscribeRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sns Show documentation
/*
* 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.sns.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.sns.AmazonSNS#unsubscribe(UnsubscribeRequest) Unsubscribe operation}.
*
* Deletes a subscription. If the subscription requires authentication
* for deletion, only the owner of the subscription or the topic's owner
* can unsubscribe, and an AWS signature is required. If the
* Unsubscribe call does not require authentication and the
* requester is not the subscription owner, a final cancellation message
* is delivered to the endpoint, so that the endpoint owner can easily
* resubscribe to the topic if the Unsubscribe request was
* unintended.
*
*
* @see com.amazonaws.services.sns.AmazonSNS#unsubscribe(UnsubscribeRequest)
*/
public class UnsubscribeRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The ARN of the subscription to be deleted.
*/
private String subscriptionArn;
/**
* Default constructor for a new UnsubscribeRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public UnsubscribeRequest() {}
/**
* Constructs a new UnsubscribeRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param subscriptionArn The ARN of the subscription to be deleted.
*/
public UnsubscribeRequest(String subscriptionArn) {
setSubscriptionArn(subscriptionArn);
}
/**
* The ARN of the subscription to be deleted.
*
* @return The ARN of the subscription to be deleted.
*/
public String getSubscriptionArn() {
return subscriptionArn;
}
/**
* The ARN of the subscription to be deleted.
*
* @param subscriptionArn The ARN of the subscription to be deleted.
*/
public void setSubscriptionArn(String subscriptionArn) {
this.subscriptionArn = subscriptionArn;
}
/**
* The ARN of the subscription to be deleted.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param subscriptionArn The ARN of the subscription to be deleted.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UnsubscribeRequest withSubscriptionArn(String subscriptionArn) {
this.subscriptionArn = subscriptionArn;
return this;
}
/**
* 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 (getSubscriptionArn() != null) sb.append("SubscriptionArn: " + getSubscriptionArn() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSubscriptionArn() == null) ? 0 : getSubscriptionArn().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof UnsubscribeRequest == false) return false;
UnsubscribeRequest other = (UnsubscribeRequest)obj;
if (other.getSubscriptionArn() == null ^ this.getSubscriptionArn() == null) return false;
if (other.getSubscriptionArn() != null && other.getSubscriptionArn().equals(this.getSubscriptionArn()) == false) return false;
return true;
}
}