com.amazonaws.services.sns.model

Class UnsubscribeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.UnsubscribeRequest

All Implemented Interfaces:

Serializable

public class UnsubscribeRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the Unsubscribe operation.

The Unsubscribe action 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 Also:

AmazonSNS.unsubscribe(UnsubscribeRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnsubscribeRequest() Default constructor for a new UnsubscribeRequest object.
UnsubscribeRequest(String subscriptionArn) Constructs a new UnsubscribeRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getSubscriptionArn() The ARN of the subscription to be deleted.
int	hashCode()
void	setSubscriptionArn(String subscriptionArn) The ARN of the subscription to be deleted.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UnsubscribeRequest	withSubscriptionArn(String subscriptionArn) The ARN of the subscription to be deleted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UnsubscribeRequest

public UnsubscribeRequest()

Default constructor for a new UnsubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

UnsubscribeRequest

public UnsubscribeRequest(String subscriptionArn)

Constructs a new UnsubscribeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

subscriptionArn - The ARN of the subscription to be deleted.

Method Detail

getSubscriptionArn

public String getSubscriptionArn()

The ARN of the subscription to be deleted.

Returns:

The ARN of the subscription to be deleted.

setSubscriptionArn

public void setSubscriptionArn(String subscriptionArn)

The ARN of the subscription to be deleted.

Parameters:

subscriptionArn - The ARN of the subscription to be deleted.

withSubscriptionArn

public UnsubscribeRequest withSubscriptionArn(String subscriptionArn)

The ARN of the subscription to be deleted.

Returns a reference to this object so that method calls can be chained together.

Parameters:

subscriptionArn - The ARN of the subscription to be deleted.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object