com.amazonaws.services.sns.model

Class ConfirmSubscriptionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sns.model.ConfirmSubscriptionRequest

All Implemented Interfaces:

Serializable

public class ConfirmSubscriptionRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ConfirmSubscription operation.

The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

See Also:

AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfirmSubscriptionRequest() Default constructor for a new ConfirmSubscriptionRequest object.
ConfirmSubscriptionRequest(String topicArn, String token) Constructs a new ConfirmSubscriptionRequest object.
ConfirmSubscriptionRequest(String topicArn, String token, String authenticateOnUnsubscribe) Constructs a new ConfirmSubscriptionRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAuthenticateOnUnsubscribe() Disallows unauthenticated unsubscribes of the subscription.
String	getToken() Short-lived token sent to an endpoint during the Subscribe action.
String	getTopicArn() The ARN of the topic for which you wish to confirm a subscription.
int	hashCode()
void	setAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe) Disallows unauthenticated unsubscribes of the subscription.
void	setToken(String token) Short-lived token sent to an endpoint during the Subscribe action.
void	setTopicArn(String topicArn) The ARN of the topic for which you wish to confirm a subscription.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ConfirmSubscriptionRequest	withAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe) Disallows unauthenticated unsubscribes of the subscription.
ConfirmSubscriptionRequest	withToken(String token) Short-lived token sent to an endpoint during the Subscribe action.
ConfirmSubscriptionRequest	withTopicArn(String topicArn) The ARN of the topic for which you wish to confirm a subscription.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfirmSubscriptionRequest

public ConfirmSubscriptionRequest()

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

ConfirmSubscriptionRequest

public ConfirmSubscriptionRequest(String topicArn,
                          String token)

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

Parameters:

topicArn - The ARN of the topic for which you wish to confirm a subscription.

token - Short-lived token sent to an endpoint during the Subscribe action.

ConfirmSubscriptionRequest

public ConfirmSubscriptionRequest(String topicArn,
                          String token,
                          String authenticateOnUnsubscribe)

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

Parameters:

topicArn - The ARN of the topic for which you wish to confirm a subscription.

token - Short-lived token sent to an endpoint during the Subscribe action.

authenticateOnUnsubscribe - Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

Method Detail

getTopicArn

public String getTopicArn()

The ARN of the topic for which you wish to confirm a subscription.

Returns:

The ARN of the topic for which you wish to confirm a subscription.

setTopicArn

public void setTopicArn(String topicArn)

The ARN of the topic for which you wish to confirm a subscription.

Parameters:

topicArn - The ARN of the topic for which you wish to confirm a subscription.

withTopicArn

public ConfirmSubscriptionRequest withTopicArn(String topicArn)

The ARN of the topic for which you wish to confirm a subscription.

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

Parameters:

topicArn - The ARN of the topic for which you wish to confirm a subscription.

Returns:

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

getToken

public String getToken()

Short-lived token sent to an endpoint during the Subscribe action.

Returns:

Short-lived token sent to an endpoint during the Subscribe action.

setToken

public void setToken(String token)

Short-lived token sent to an endpoint during the Subscribe action.

Parameters:

token - Short-lived token sent to an endpoint during the Subscribe action.

withToken

public ConfirmSubscriptionRequest withToken(String token)

Short-lived token sent to an endpoint during the Subscribe action.

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

Parameters:

token - Short-lived token sent to an endpoint during the Subscribe action.

Returns:

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

getAuthenticateOnUnsubscribe

public String getAuthenticateOnUnsubscribe()

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

Returns:

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

setAuthenticateOnUnsubscribe

public void setAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

Parameters:

authenticateOnUnsubscribe - Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

withAuthenticateOnUnsubscribe

public ConfirmSubscriptionRequest withAuthenticateOnUnsubscribe(String authenticateOnUnsubscribe)

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

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

Parameters:

authenticateOnUnsubscribe - Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

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